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 Api_IsConstruct(x interface{}) *bool
- func App_IsConstruct(x interface{}) *bool
- func Authorization_IsConstruct(x interface{}) *bool
- func CustomDomain_IsConstruct(x interface{}) *bool
- func Deployment_IsConstruct(x interface{}) *bool
- func Group_IsConstruct(x interface{}) *bool
- func Instance_IsConstruct(x interface{}) *bool
- func LogConfig_IsConstruct(x interface{}) *bool
- func NewApi_Override(a Api, scope alicloudroscdkcore.Construct, id *string, props *ApiProps, ...)
- func NewApp_Override(a App, scope alicloudroscdkcore.Construct, id *string, props *AppProps, ...)
- func NewAuthorization_Override(a Authorization, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewCustomDomain_Override(c CustomDomain, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewDeployment_Override(d Deployment, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewGroup_Override(g Group, scope alicloudroscdkcore.Construct, id *string, props *GroupProps, ...)
- func NewInstance_Override(i Instance, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewLogConfig_Override(l LogConfig, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewPluginAttachment_Override(p PluginAttachment, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewPlugin_Override(p Plugin, scope alicloudroscdkcore.Construct, id *string, props *PluginProps, ...)
- func NewRosApi_Override(r RosApi, scope alicloudroscdkcore.Construct, id *string, props *RosApiProps, ...)
- func NewRosApp_Override(r RosApp, scope alicloudroscdkcore.Construct, id *string, props *RosAppProps, ...)
- func NewRosAuthorization_Override(r RosAuthorization, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosCustomDomain_Override(r RosCustomDomain, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosDeployment_Override(r RosDeployment, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosGroup_Override(r RosGroup, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosInstance_Override(r RosInstance, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosLogConfig_Override(r RosLogConfig, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosPluginAttachment_Override(r RosPluginAttachment, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosPlugin_Override(r RosPlugin, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosSignatureBinding_Override(r RosSignatureBinding, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosSignature_Override(r RosSignature, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosStageConfig_Override(r RosStageConfig, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosTrafficControlBinding_Override(r RosTrafficControlBinding, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosTrafficControl_Override(r RosTrafficControl, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosVpcAccessConfig_Override(r RosVpcAccessConfig, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewSignatureBinding_Override(s SignatureBinding, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewSignature_Override(s Signature, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewStageConfig_Override(s StageConfig, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewTrafficControlBinding_Override(t TrafficControlBinding, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewTrafficControl_Override(t TrafficControl, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewVpcAccessConfig_Override(v VpcAccessConfig, scope alicloudroscdkcore.Construct, id *string, ...)
- func PluginAttachment_IsConstruct(x interface{}) *bool
- func Plugin_IsConstruct(x interface{}) *bool
- func RosApi_IsConstruct(x interface{}) *bool
- func RosApi_IsRosElement(x interface{}) *bool
- func RosApi_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosApi_ROS_RESOURCE_TYPE_NAME() *string
- func RosApp_IsConstruct(x interface{}) *bool
- func RosApp_IsRosElement(x interface{}) *bool
- func RosApp_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosApp_ROS_RESOURCE_TYPE_NAME() *string
- func RosAuthorization_IsConstruct(x interface{}) *bool
- func RosAuthorization_IsRosElement(x interface{}) *bool
- func RosAuthorization_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosAuthorization_ROS_RESOURCE_TYPE_NAME() *string
- func RosCustomDomain_IsConstruct(x interface{}) *bool
- func RosCustomDomain_IsRosElement(x interface{}) *bool
- func RosCustomDomain_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosCustomDomain_ROS_RESOURCE_TYPE_NAME() *string
- func RosDeployment_IsConstruct(x interface{}) *bool
- func RosDeployment_IsRosElement(x interface{}) *bool
- func RosDeployment_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosDeployment_ROS_RESOURCE_TYPE_NAME() *string
- func RosGroup_IsConstruct(x interface{}) *bool
- func RosGroup_IsRosElement(x interface{}) *bool
- func RosGroup_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosGroup_ROS_RESOURCE_TYPE_NAME() *string
- func RosInstance_IsConstruct(x interface{}) *bool
- func RosInstance_IsRosElement(x interface{}) *bool
- func RosInstance_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosInstance_ROS_RESOURCE_TYPE_NAME() *string
- func RosLogConfig_IsConstruct(x interface{}) *bool
- func RosLogConfig_IsRosElement(x interface{}) *bool
- func RosLogConfig_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosLogConfig_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 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 RosSignatureBinding_IsConstruct(x interface{}) *bool
- func RosSignatureBinding_IsRosElement(x interface{}) *bool
- func RosSignatureBinding_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosSignatureBinding_ROS_RESOURCE_TYPE_NAME() *string
- func RosSignature_IsConstruct(x interface{}) *bool
- func RosSignature_IsRosElement(x interface{}) *bool
- func RosSignature_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosSignature_ROS_RESOURCE_TYPE_NAME() *string
- func RosStageConfig_IsConstruct(x interface{}) *bool
- func RosStageConfig_IsRosElement(x interface{}) *bool
- func RosStageConfig_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosStageConfig_ROS_RESOURCE_TYPE_NAME() *string
- func RosTrafficControlBinding_IsConstruct(x interface{}) *bool
- func RosTrafficControlBinding_IsRosElement(x interface{}) *bool
- func RosTrafficControlBinding_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosTrafficControlBinding_ROS_RESOURCE_TYPE_NAME() *string
- func RosTrafficControl_IsConstruct(x interface{}) *bool
- func RosTrafficControl_IsRosElement(x interface{}) *bool
- func RosTrafficControl_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosTrafficControl_ROS_RESOURCE_TYPE_NAME() *string
- func RosVpcAccessConfig_IsConstruct(x interface{}) *bool
- func RosVpcAccessConfig_IsRosElement(x interface{}) *bool
- func RosVpcAccessConfig_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosVpcAccessConfig_ROS_RESOURCE_TYPE_NAME() *string
- func SignatureBinding_IsConstruct(x interface{}) *bool
- func Signature_IsConstruct(x interface{}) *bool
- func StageConfig_IsConstruct(x interface{}) *bool
- func TrafficControlBinding_IsConstruct(x interface{}) *bool
- func TrafficControl_IsConstruct(x interface{}) *bool
- func VpcAccessConfig_IsConstruct(x interface{}) *bool
- type Api
- type ApiProps
- type App
- type AppProps
- type Authorization
- type AuthorizationProps
- type CustomDomain
- type CustomDomainProps
- type Deployment
- type DeploymentProps
- type Group
- type GroupProps
- type IApi
- type IApp
- type IAuthorization
- type ICustomDomain
- type IDeployment
- type IGroup
- type IInstance
- type ILogConfig
- type IPlugin
- type IPluginAttachment
- type ISignature
- type ISignatureBinding
- type IStageConfig
- type ITrafficControl
- type ITrafficControlBinding
- type IVpcAccessConfig
- type Instance
- type InstanceProps
- type LogConfig
- type LogConfigProps
- type Plugin
- type PluginAttachment
- type PluginAttachmentProps
- type PluginProps
- type RosApi
- type RosApiProps
- type RosApi_ConstParametersProperty
- type RosApi_ErrorCodeSamplesProperty
- type RosApi_FunctionComputeConfigProperty
- type RosApi_MockHeadersProperty
- type RosApi_OpenIdConnectConfigProperty
- type RosApi_RequestConfigProperty
- type RosApi_RequestParametersProperty
- type RosApi_ServiceConfigProperty
- type RosApi_ServiceParametersMapProperty
- type RosApi_ServiceParametersProperty
- type RosApi_SystemParametersProperty
- type RosApi_TagsProperty
- type RosApi_VpcConfigProperty
- type RosApp
- type RosAppProps
- type RosApp_TagsProperty
- type RosAuthorization
- type RosAuthorizationProps
- type RosCustomDomain
- type RosCustomDomainProps
- type RosDeployment
- type RosDeploymentProps
- type RosGroup
- type RosGroupProps
- type RosGroup_TagsProperty
- type RosInstance
- type RosInstanceProps
- type RosInstance_TagsProperty
- type RosLogConfig
- type RosLogConfigProps
- type RosPlugin
- type RosPluginAttachment
- type RosPluginAttachmentProps
- type RosPluginProps
- type RosPlugin_TagsProperty
- type RosSignature
- type RosSignatureBinding
- type RosSignatureBindingProps
- type RosSignatureProps
- type RosStageConfig
- type RosStageConfigProps
- type RosTrafficControl
- type RosTrafficControlBinding
- type RosTrafficControlBindingProps
- type RosTrafficControlProps
- type RosTrafficControl_SpecialProperty
- type RosVpcAccessConfig
- type RosVpcAccessConfigProps
- type Signature
- type SignatureBinding
- type SignatureBindingProps
- type SignatureProps
- type StageConfig
- type StageConfigProps
- type TrafficControl
- type TrafficControlBinding
- type TrafficControlBindingProps
- type TrafficControlProps
- type VpcAccessConfig
- type VpcAccessConfigProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Api_IsConstruct ¶
func Api_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func App_IsConstruct ¶
func App_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Authorization_IsConstruct ¶
func Authorization_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func CustomDomain_IsConstruct ¶
func CustomDomain_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Deployment_IsConstruct ¶
func Deployment_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Group_IsConstruct ¶
func Group_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Instance_IsConstruct ¶
func Instance_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func LogConfig_IsConstruct ¶
func LogConfig_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func NewApi_Override ¶
func NewApi_Override(a Api, scope alicloudroscdkcore.Construct, id *string, props *ApiProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewApp_Override ¶
func NewApp_Override(a App, scope alicloudroscdkcore.Construct, id *string, props *AppProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewAuthorization_Override ¶
func NewAuthorization_Override(a Authorization, scope alicloudroscdkcore.Construct, id *string, props *AuthorizationProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewCustomDomain_Override ¶
func NewCustomDomain_Override(c CustomDomain, scope alicloudroscdkcore.Construct, id *string, props *CustomDomainProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewDeployment_Override ¶
func NewDeployment_Override(d Deployment, scope alicloudroscdkcore.Construct, id *string, props *DeploymentProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewGroup_Override ¶
func NewGroup_Override(g Group, scope alicloudroscdkcore.Construct, id *string, props *GroupProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewInstance_Override ¶
func NewInstance_Override(i Instance, scope alicloudroscdkcore.Construct, id *string, props *InstanceProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewLogConfig_Override ¶
func NewLogConfig_Override(l LogConfig, scope alicloudroscdkcore.Construct, id *string, props *LogConfigProps, 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 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 NewRosApi_Override ¶
func NewRosApi_Override(r RosApi, scope alicloudroscdkcore.Construct, id *string, props *RosApiProps, enableResourcePropertyConstraint *bool)
func NewRosApp_Override ¶
func NewRosApp_Override(r RosApp, scope alicloudroscdkcore.Construct, id *string, props *RosAppProps, enableResourcePropertyConstraint *bool)
func NewRosAuthorization_Override ¶
func NewRosAuthorization_Override(r RosAuthorization, scope alicloudroscdkcore.Construct, id *string, props *RosAuthorizationProps, enableResourcePropertyConstraint *bool)
func NewRosCustomDomain_Override ¶
func NewRosCustomDomain_Override(r RosCustomDomain, scope alicloudroscdkcore.Construct, id *string, props *RosCustomDomainProps, enableResourcePropertyConstraint *bool)
func NewRosDeployment_Override ¶
func NewRosDeployment_Override(r RosDeployment, scope alicloudroscdkcore.Construct, id *string, props *RosDeploymentProps, enableResourcePropertyConstraint *bool)
func NewRosGroup_Override ¶
func NewRosGroup_Override(r RosGroup, scope alicloudroscdkcore.Construct, id *string, props *RosGroupProps, enableResourcePropertyConstraint *bool)
func NewRosInstance_Override ¶
func NewRosInstance_Override(r RosInstance, scope alicloudroscdkcore.Construct, id *string, props *RosInstanceProps, enableResourcePropertyConstraint *bool)
func NewRosLogConfig_Override ¶
func NewRosLogConfig_Override(r RosLogConfig, scope alicloudroscdkcore.Construct, id *string, props *RosLogConfigProps, enableResourcePropertyConstraint *bool)
func NewRosPluginAttachment_Override ¶
func NewRosPluginAttachment_Override(r RosPluginAttachment, scope alicloudroscdkcore.Construct, id *string, props *RosPluginAttachmentProps, enableResourcePropertyConstraint *bool)
func NewRosPlugin_Override ¶
func NewRosPlugin_Override(r RosPlugin, scope alicloudroscdkcore.Construct, id *string, props *RosPluginProps, enableResourcePropertyConstraint *bool)
func NewRosSignatureBinding_Override ¶
func NewRosSignatureBinding_Override(r RosSignatureBinding, scope alicloudroscdkcore.Construct, id *string, props *RosSignatureBindingProps, enableResourcePropertyConstraint *bool)
func NewRosSignature_Override ¶
func NewRosSignature_Override(r RosSignature, scope alicloudroscdkcore.Construct, id *string, props *RosSignatureProps, enableResourcePropertyConstraint *bool)
func NewRosStageConfig_Override ¶
func NewRosStageConfig_Override(r RosStageConfig, scope alicloudroscdkcore.Construct, id *string, props *RosStageConfigProps, enableResourcePropertyConstraint *bool)
func NewRosTrafficControlBinding_Override ¶
func NewRosTrafficControlBinding_Override(r RosTrafficControlBinding, scope alicloudroscdkcore.Construct, id *string, props *RosTrafficControlBindingProps, enableResourcePropertyConstraint *bool)
func NewRosTrafficControl_Override ¶
func NewRosTrafficControl_Override(r RosTrafficControl, scope alicloudroscdkcore.Construct, id *string, props *RosTrafficControlProps, enableResourcePropertyConstraint *bool)
func NewRosVpcAccessConfig_Override ¶
func NewRosVpcAccessConfig_Override(r RosVpcAccessConfig, scope alicloudroscdkcore.Construct, id *string, props *RosVpcAccessConfigProps, enableResourcePropertyConstraint *bool)
func NewSignatureBinding_Override ¶
func NewSignatureBinding_Override(s SignatureBinding, scope alicloudroscdkcore.Construct, id *string, props *SignatureBindingProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewSignature_Override ¶
func NewSignature_Override(s Signature, scope alicloudroscdkcore.Construct, id *string, props *SignatureProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewStageConfig_Override ¶
func NewStageConfig_Override(s StageConfig, scope alicloudroscdkcore.Construct, id *string, props *StageConfigProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewTrafficControlBinding_Override ¶
func NewTrafficControlBinding_Override(t TrafficControlBinding, scope alicloudroscdkcore.Construct, id *string, props *TrafficControlBindingProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewTrafficControl_Override ¶
func NewTrafficControl_Override(t TrafficControl, scope alicloudroscdkcore.Construct, id *string, props *TrafficControlProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewVpcAccessConfig_Override ¶
func NewVpcAccessConfig_Override(v VpcAccessConfig, scope alicloudroscdkcore.Construct, id *string, props *VpcAccessConfigProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func PluginAttachment_IsConstruct ¶
func PluginAttachment_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 RosApi_IsConstruct ¶
func RosApi_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosApi_IsRosElement ¶
func RosApi_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 RosApi_IsRosResource ¶
func RosApi_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosApi_ROS_RESOURCE_TYPE_NAME ¶
func RosApi_ROS_RESOURCE_TYPE_NAME() *string
func RosApp_IsConstruct ¶
func RosApp_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosApp_IsRosElement ¶
func RosApp_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 RosApp_IsRosResource ¶
func RosApp_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosApp_ROS_RESOURCE_TYPE_NAME ¶
func RosApp_ROS_RESOURCE_TYPE_NAME() *string
func RosAuthorization_IsConstruct ¶
func RosAuthorization_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosAuthorization_IsRosElement ¶
func RosAuthorization_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 RosAuthorization_IsRosResource ¶
func RosAuthorization_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosAuthorization_ROS_RESOURCE_TYPE_NAME ¶
func RosAuthorization_ROS_RESOURCE_TYPE_NAME() *string
func RosCustomDomain_IsConstruct ¶
func RosCustomDomain_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosCustomDomain_IsRosElement ¶
func RosCustomDomain_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 RosCustomDomain_IsRosResource ¶
func RosCustomDomain_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosCustomDomain_ROS_RESOURCE_TYPE_NAME ¶
func RosCustomDomain_ROS_RESOURCE_TYPE_NAME() *string
func RosDeployment_IsConstruct ¶
func RosDeployment_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosDeployment_IsRosElement ¶
func RosDeployment_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 RosDeployment_IsRosResource ¶
func RosDeployment_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosDeployment_ROS_RESOURCE_TYPE_NAME ¶
func RosDeployment_ROS_RESOURCE_TYPE_NAME() *string
func RosGroup_IsConstruct ¶
func RosGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosGroup_IsRosElement ¶
func RosGroup_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 RosGroup_IsRosResource ¶
func RosGroup_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosGroup_ROS_RESOURCE_TYPE_NAME ¶
func RosGroup_ROS_RESOURCE_TYPE_NAME() *string
func RosInstance_IsConstruct ¶
func RosInstance_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosInstance_IsRosElement ¶
func RosInstance_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 RosInstance_IsRosResource ¶
func RosInstance_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosInstance_ROS_RESOURCE_TYPE_NAME ¶
func RosInstance_ROS_RESOURCE_TYPE_NAME() *string
func RosLogConfig_IsConstruct ¶
func RosLogConfig_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosLogConfig_IsRosElement ¶
func RosLogConfig_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 RosLogConfig_IsRosResource ¶
func RosLogConfig_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosLogConfig_ROS_RESOURCE_TYPE_NAME ¶
func RosLogConfig_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 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 RosSignatureBinding_IsConstruct ¶
func RosSignatureBinding_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosSignatureBinding_IsRosElement ¶
func RosSignatureBinding_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 RosSignatureBinding_IsRosResource ¶
func RosSignatureBinding_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosSignatureBinding_ROS_RESOURCE_TYPE_NAME ¶
func RosSignatureBinding_ROS_RESOURCE_TYPE_NAME() *string
func RosSignature_IsConstruct ¶
func RosSignature_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosSignature_IsRosElement ¶
func RosSignature_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 RosSignature_IsRosResource ¶
func RosSignature_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosSignature_ROS_RESOURCE_TYPE_NAME ¶
func RosSignature_ROS_RESOURCE_TYPE_NAME() *string
func RosStageConfig_IsConstruct ¶
func RosStageConfig_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosStageConfig_IsRosElement ¶
func RosStageConfig_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 RosStageConfig_IsRosResource ¶
func RosStageConfig_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosStageConfig_ROS_RESOURCE_TYPE_NAME ¶
func RosStageConfig_ROS_RESOURCE_TYPE_NAME() *string
func RosTrafficControlBinding_IsConstruct ¶
func RosTrafficControlBinding_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosTrafficControlBinding_IsRosElement ¶
func RosTrafficControlBinding_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 RosTrafficControlBinding_IsRosResource ¶
func RosTrafficControlBinding_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosTrafficControlBinding_ROS_RESOURCE_TYPE_NAME ¶
func RosTrafficControlBinding_ROS_RESOURCE_TYPE_NAME() *string
func RosTrafficControl_IsConstruct ¶
func RosTrafficControl_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosTrafficControl_IsRosElement ¶
func RosTrafficControl_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 RosTrafficControl_IsRosResource ¶
func RosTrafficControl_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosTrafficControl_ROS_RESOURCE_TYPE_NAME ¶
func RosTrafficControl_ROS_RESOURCE_TYPE_NAME() *string
func RosVpcAccessConfig_IsConstruct ¶
func RosVpcAccessConfig_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosVpcAccessConfig_IsRosElement ¶
func RosVpcAccessConfig_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 RosVpcAccessConfig_IsRosResource ¶
func RosVpcAccessConfig_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosVpcAccessConfig_ROS_RESOURCE_TYPE_NAME ¶
func RosVpcAccessConfig_ROS_RESOURCE_TYPE_NAME() *string
func SignatureBinding_IsConstruct ¶
func SignatureBinding_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Signature_IsConstruct ¶
func Signature_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func StageConfig_IsConstruct ¶
func StageConfig_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func TrafficControlBinding_IsConstruct ¶
func TrafficControlBinding_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func TrafficControl_IsConstruct ¶
func TrafficControl_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func VpcAccessConfig_IsConstruct ¶
func VpcAccessConfig_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
Types ¶
type Api ¶
type Api interface { alicloudroscdkcore.Resource IApi // Attribute ApiId: The id of the API. AttrApiId() 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() *ApiProps 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::ApiGateway::Api`, which is used to create an API.
type ApiProps ¶
type ApiProps struct { // Property apiName: The name of the API.It must be 4 to 128 characters in length, and can contain letters, digits, underscores (_), dashes (-), spaces and dots (.), It must start with a letter. ApiName interface{} `field:"required" json:"apiName" yaml:"apiName"` // Property groupId: The id of the Group. GroupId interface{} `field:"required" json:"groupId" yaml:"groupId"` // Property requestConfig: The configuration of the request. RequestConfig interface{} `field:"required" json:"requestConfig" yaml:"requestConfig"` // Property serviceConfig: The configuration of the service. ServiceConfig interface{} `field:"required" json:"serviceConfig" yaml:"serviceConfig"` // Property visibility: Whether to make the API public. // // "PUBLIC" or "PRIVATE". Visibility interface{} `field:"required" json:"visibility" yaml:"visibility"` // Property allowSignatureMethod: If the AuthType is APP authentication, you need to pass this value to specify the signature algorithm. // // If you do not specify this parameter, the default value HmacSHA256 is used. Valid values: // HmacSHA256 // HmacSHA1,HmacSHA256. AllowSignatureMethod interface{} `field:"optional" json:"allowSignatureMethod" yaml:"allowSignatureMethod"` // Property appCodeAuthType: When AuthType is APP authentication, the optional values are as follows: If not passed, the default value is DEFAULT: DEFAULT: Default (set by group). // // DISABLE: Not allowed // HEADER: Allow AppCode header authentication // HEADER_QUERY: Allow AppCode header and query authentication. AppCodeAuthType interface{} `field:"optional" json:"appCodeAuthType" yaml:"appCodeAuthType"` // Property authType: Type of authorization of the API . // // "APP","ANONYMOUS", or "APPOPENID". AuthType interface{} `field:"optional" json:"authType" yaml:"authType"` // Property constParameters: The const parameters. ConstParameters interface{} `field:"optional" json:"constParameters" yaml:"constParameters"` // Property description: Description of the API, less than 180 characters. Description interface{} `field:"optional" json:"description" yaml:"description"` // Property disableInternet: Set DisableInternet to true, only support intranet to call API. // // Set DisableInternet to false, then the call is not restricted. DisableInternet interface{} `field:"optional" json:"disableInternet" yaml:"disableInternet"` // Property errorCodeSamples: The Error Code samples. ErrorCodeSamples interface{} `field:"optional" json:"errorCodeSamples" yaml:"errorCodeSamples"` // Property failResultSample: The sample of the fail result. FailResultSample interface{} `field:"optional" json:"failResultSample" yaml:"failResultSample"` // Property forceNonceCheck: Set ForceNonceCheck to true, compulsorily check X-Ca-Nonce when requesting, this is the unique identifier of the request, generally using UUID to identify. // // The API gateway will verify the validity of this parameter after receiving this parameter. // The same value can only be used once within 15 minutes. It can effectively prevent API replay attacks. // Set ForceNonceCheck to false, then no check. ForceNonceCheck interface{} `field:"optional" json:"forceNonceCheck" yaml:"forceNonceCheck"` // Property openIdConnectConfig: The configuration of the open id. OpenIdConnectConfig interface{} `field:"optional" json:"openIdConnectConfig" yaml:"openIdConnectConfig"` // Property requestParameters: The request parameters. RequestParameters interface{} `field:"optional" json:"requestParameters" yaml:"requestParameters"` // Property resultBodyModel: The return result of the API. ResultBodyModel interface{} `field:"optional" json:"resultBodyModel" yaml:"resultBodyModel"` // Property resultDescriptions: The return description of the API. ResultDescriptions interface{} `field:"optional" json:"resultDescriptions" yaml:"resultDescriptions"` // Property resultSample: The sample of the result. ResultSample interface{} `field:"optional" json:"resultSample" yaml:"resultSample"` // Property resultType: The format of service's response, "JSON", "TEXT", "BINARY", "XML", "HTML" or "PASSTHROUGH". // // Default is "JSON". ResultType interface{} `field:"optional" json:"resultType" yaml:"resultType"` // Property serviceParameters: The service parameters. ServiceParameters interface{} `field:"optional" json:"serviceParameters" yaml:"serviceParameters"` // Property serviceParametersMap: The mapping relation between (request parameters\const parameters\system parameters) and service parameters. ServiceParametersMap interface{} `field:"optional" json:"serviceParametersMap" yaml:"serviceParametersMap"` // Property systemParameters: The system parameters. SystemParameters interface{} `field:"optional" json:"systemParameters" yaml:"systemParameters"` // Property tags: Tags to attach to instance. // // Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required. Tags *[]*RosApi_TagsProperty `field:"optional" json:"tags" yaml:"tags"` // Property webSocketApiType: The type of the two-way communication API. // // COMMON: common API // REGISTER: registered API // UNREGISTER: unregistered API // NOTIFY: downstream notification API. WebSocketApiType interface{} `field:"optional" json:"webSocketApiType" yaml:"webSocketApiType"` }
Properties for defining a `Api`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-api
type App ¶
type App interface { alicloudroscdkcore.Resource IApp // Attribute AppCode: The code of the APP. AttrAppCode() interface{} // Attribute AppId: The id of the created APP. AttrAppId() interface{} // Attribute AppKey: The key of the APP. AttrAppKey() interface{} // Attribute AppSecret: The secret of the APP. AttrAppSecret() interface{} // Attribute Tags: Tags of app. AttrTags() 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() *AppProps 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::ApiGateway::App`, which is used to create an application.
Before you call a third-party API, you must create an application and use the application as an identity to call the API.
type AppProps ¶
type AppProps struct { // Property appName: The name of the App.Need [4, 26] Chinese\English\Number characters or "_",and should start with Chinese\/English character. AppName interface{} `field:"required" json:"appName" yaml:"appName"` // Property appCode: The app code of the APP. // // The length is 8~128 English characters, which can contain numbers, underscores (_) and dashes (-),and AppCode is globally unique. AppCode interface{} `field:"optional" json:"appCode" yaml:"appCode"` // Property appKey: The key of the APP. // // The length is 8~128 English characters, which can contain numbers, underscores (_) and dashes (-), // and AppKey is globally unique. AppKey interface{} `field:"optional" json:"appKey" yaml:"appKey"` // Property appSecret: The secret of the APP. // // The length is 8~128 English characters, which can contain numbers, underscores (_) and dashes (-). AppSecret interface{} `field:"optional" json:"appSecret" yaml:"appSecret"` // Property description: Description of the App, less than 180 characters. Description interface{} `field:"optional" json:"description" yaml:"description"` // Property tags: Tags to attach to app. // // Max support 20 tags to add during create app. Each tag with two properties Key and Value, and Key is required. Tags *[]*RosApp_TagsProperty `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `App`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-app
type Authorization ¶
type Authorization interface { alicloudroscdkcore.Resource IAuthorization 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() *AuthorizationProps 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::ApiGateway::Authorization`, which is used to authorize applications to call APIs.
func NewAuthorization ¶
func NewAuthorization(scope alicloudroscdkcore.Construct, id *string, props *AuthorizationProps, enableResourcePropertyConstraint *bool) Authorization
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type AuthorizationProps ¶
type AuthorizationProps struct { // Property apiIds: APIs to authorize. ApiIds interface{} `field:"required" json:"apiIds" yaml:"apiIds"` // Property appIds: APPs are authorized to APIs. AppIds interface{} `field:"required" json:"appIds" yaml:"appIds"` // Property groupId: The id of the group. GroupId interface{} `field:"required" json:"groupId" yaml:"groupId"` // Property stageName: Authorize in this stage. StageName interface{} `field:"required" json:"stageName" yaml:"stageName"` // Property authValidTime: The time (UTC) when the authorization expires. // // If this parameter is empty, the authorization does not expire. // Pattern: YYYY-MM-DDThh:mm:ssZ. AuthValidTime interface{} `field:"optional" json:"authValidTime" yaml:"authValidTime"` // Property description: Description of the authorization, less than 180 characters. Description interface{} `field:"optional" json:"description" yaml:"description"` }
Properties for defining a `Authorization`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-authorization
type CustomDomain ¶
type CustomDomain interface { alicloudroscdkcore.Resource ICustomDomain // Attribute CertificateId: The id of the certificate. AttrCertificateId() 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() *CustomDomainProps 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::ApiGateway::CustomDomain`, which is used to bind a custom domain name and upload a Secure Sockets Layer (SSL) certificate to a specific API group.
func NewCustomDomain ¶
func NewCustomDomain(scope alicloudroscdkcore.Construct, id *string, props *CustomDomainProps, enableResourcePropertyConstraint *bool) CustomDomain
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type CustomDomainProps ¶
type CustomDomainProps struct { // Property domainName: Custom domain name. DomainName interface{} `field:"required" json:"domainName" yaml:"domainName"` // Property groupId: The id of the Group. GroupId interface{} `field:"required" json:"groupId" yaml:"groupId"` // Property certificateBody: SSL certificate body. CertificateBody interface{} `field:"optional" json:"certificateBody" yaml:"certificateBody"` // Property certificateName: SSL certificate name. CertificateName interface{} `field:"optional" json:"certificateName" yaml:"certificateName"` // Property certificatePrivateKey: SSL certificate key. CertificatePrivateKey interface{} `field:"optional" json:"certificatePrivateKey" yaml:"certificatePrivateKey"` }
Properties for defining a `CustomDomain`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-customdomain
type Deployment ¶
type Deployment interface { alicloudroscdkcore.Resource IDeployment 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() *DeploymentProps 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::ApiGateway::Deployment`, which is used to publish an API to a specific runtime environment, or switch a published API to a specific version.
func NewDeployment ¶
func NewDeployment(scope alicloudroscdkcore.Construct, id *string, props *DeploymentProps, enableResourcePropertyConstraint *bool) Deployment
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type DeploymentProps ¶
type DeploymentProps struct { // Property apiId: The id of the API. ApiId interface{} `field:"required" json:"apiId" yaml:"apiId"` // Property groupId: The id of the Group. GroupId interface{} `field:"required" json:"groupId" yaml:"groupId"` // Property stageName: Bind traffic in this stage. StageName interface{} `field:"required" json:"stageName" yaml:"stageName"` // Property description: Description of the deployment, less than 180 characters. Description interface{} `field:"optional" json:"description" yaml:"description"` // Property historyVersion: The history version. HistoryVersion interface{} `field:"optional" json:"historyVersion" yaml:"historyVersion"` }
Properties for defining a `Deployment`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-deployment
type Group ¶
type Group interface { alicloudroscdkcore.Resource IGroup // Attribute GroupId: The id of the created Group resource. AttrGroupId() interface{} // Attribute SubDomain: The sub domain assigned to the Group by the system. AttrSubDomain() interface{} // Attribute Tags: Tags of app. AttrTags() 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() *GroupProps 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::ApiGateway::Group`, which is used to create an API group.
func NewGroup ¶
func NewGroup(scope alicloudroscdkcore.Construct, id *string, props *GroupProps, enableResourcePropertyConstraint *bool) Group
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type GroupProps ¶
type GroupProps struct { // Property groupName: The name of the Group.It must be 4 to 128 characters in length, and can contain letters, digits, underscores (_), dashes (-), spaces and dots (.), It must start with a letter. GroupName interface{} `field:"required" json:"groupName" yaml:"groupName"` // Property basePath: The base path of API. BasePath interface{} `field:"optional" json:"basePath" yaml:"basePath"` // Property description: Description of the Group, less than 180 characters. Description interface{} `field:"optional" json:"description" yaml:"description"` // Property instanceId: API gateway instance ID. // // For example, "api-shared-vpc-001" means vpc instance, while "api-shared-classic-001" means classic instance. InstanceId interface{} `field:"optional" json:"instanceId" yaml:"instanceId"` // Property internetEnable: Enable or disable internet subdomain. // // True for enable. InternetEnable interface{} `field:"optional" json:"internetEnable" yaml:"internetEnable"` // Property passthroughHeaders: Pass through headers setting. // // values: // host: pass through host headers. PassthroughHeaders interface{} `field:"optional" json:"passthroughHeaders" yaml:"passthroughHeaders"` // Property tags: Tags to attach to group. // // Max support 20 tags to add during create group. Each tag with two properties Key and Value, and Key is required. Tags *[]*RosGroup_TagsProperty `field:"optional" json:"tags" yaml:"tags"` // Property vpcIntranetEnable: Enable or disable VPC intranet subdomain. // // True for enable. VpcIntranetEnable interface{} `field:"optional" json:"vpcIntranetEnable" yaml:"vpcIntranetEnable"` }
Properties for defining a `Group`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-group
type IApi ¶ added in v1.6.0
type IApi interface { alicloudroscdkcore.IResource // Attribute ApiId: The id of the API. AttrApiId() interface{} Props() *ApiProps }
Represents a `Api`.
type IApp ¶ added in v1.6.0
type IApp interface { alicloudroscdkcore.IResource // Attribute AppCode: The code of the APP. AttrAppCode() interface{} // Attribute AppId: The id of the created APP. AttrAppId() interface{} // Attribute AppKey: The key of the APP. AttrAppKey() interface{} // Attribute AppSecret: The secret of the APP. AttrAppSecret() interface{} // Attribute Tags: Tags of app. AttrTags() interface{} Props() *AppProps }
Represents a `App`.
type IAuthorization ¶ added in v1.6.0
type IAuthorization interface { alicloudroscdkcore.IResource Props() *AuthorizationProps }
Represents a `Authorization`.
type ICustomDomain ¶ added in v1.6.0
type ICustomDomain interface { alicloudroscdkcore.IResource // Attribute CertificateId: The id of the certificate. AttrCertificateId() interface{} Props() *CustomDomainProps }
Represents a `CustomDomain`.
type IDeployment ¶ added in v1.6.0
type IDeployment interface { alicloudroscdkcore.IResource Props() *DeploymentProps }
Represents a `Deployment`.
type IGroup ¶ added in v1.6.0
type IGroup interface { alicloudroscdkcore.IResource // Attribute GroupId: The id of the created Group resource. AttrGroupId() interface{} // Attribute SubDomain: The sub domain assigned to the Group by the system. AttrSubDomain() interface{} // Attribute Tags: Tags of app. AttrTags() interface{} Props() *GroupProps }
Represents a `Group`.
type IInstance ¶ added in v1.6.0
type IInstance interface { alicloudroscdkcore.IResource // Attribute EgressIpv6Enable: Whether enable egress IPV6. AttrEgressIpv6Enable() interface{} // Attribute InstanceId: Instance ID. AttrInstanceId() interface{} // Attribute InstanceType: Instance type. AttrInstanceType() interface{} // Attribute InternetEgressAddress: Internet egress dddress. AttrInternetEgressAddress() interface{} // Attribute SupportIpv6: Whether support IPV6. AttrSupportIpv6() interface{} // Attribute VpcEgressAddress: VPC network egress address. AttrVpcEgressAddress() interface{} // Attribute VpcIntranetEnable: Whether enable VPC intranet. AttrVpcIntranetEnable() interface{} // Attribute VpcSlbIntranetEnable: Whether enable VPC SLB intranet. AttrVpcSlbIntranetEnable() interface{} Props() *InstanceProps }
Represents a `Instance`.
type ILogConfig ¶ added in v1.6.0
type ILogConfig interface { alicloudroscdkcore.IResource // Attribute SlsLogStore: Logstore name of SLS. AttrSlsLogStore() interface{} // Attribute SlsProject: Project name of SLS. AttrSlsProject() interface{} Props() *LogConfigProps }
Represents a `LogConfig`.
type IPlugin ¶ added in v1.6.0
type IPlugin interface { alicloudroscdkcore.IResource // Attribute Description: The description of the plug-in, which cannot exceed 200 characters. AttrDescription() interface{} // Attribute PluginData: The definition statement of the plug-in. // // Plug-in definition statements in the JSON and YAML formats are supported. AttrPluginData() interface{} // Attribute PluginId: The generated plugin ID. AttrPluginId() interface{} // Attribute PluginName: The name of the plug-in that you want to create. // // It can contain uppercase English letters, lowercase English letters, Chinese characters, numbers, and underscores (). It must be 4 to 50 characters in length and cannot start with an underscore (). AttrPluginName() interface{} // Attribute PluginType: The type of the plug-in. // // Valid values: ipControl: indicates IP address-based access control. trafficControl: indicates throttling. backendSignature: indicates backend signature. jwtAuth: indicates JWT (OpenId Connect). cors: indicates cross-origin resource access (CORS). caching: indicates caching. AttrPluginType() interface{} Props() *PluginProps }
Represents a `Plugin`.
type IPluginAttachment ¶ added in v1.6.0
type IPluginAttachment interface { alicloudroscdkcore.IResource // Attribute ApiId: The api id. AttrApiId() interface{} // Attribute PluginId: The plugin id. AttrPluginId() interface{} Props() *PluginAttachmentProps }
Represents a `PluginAttachment`.
type ISignature ¶ added in v1.6.0
type ISignature interface { alicloudroscdkcore.IResource // Attribute SignatureId: The id of the created signature. AttrSignatureId() interface{} Props() *SignatureProps }
Represents a `Signature`.
type ISignatureBinding ¶ added in v1.6.0
type ISignatureBinding interface { alicloudroscdkcore.IResource Props() *SignatureBindingProps }
Represents a `SignatureBinding`.
type IStageConfig ¶ added in v1.6.0
type IStageConfig interface { alicloudroscdkcore.IResource Props() *StageConfigProps }
Represents a `StageConfig`.
type ITrafficControl ¶ added in v1.6.0
type ITrafficControl interface { alicloudroscdkcore.IResource // Attribute TrafficControlId: The id of the traffic control. AttrTrafficControlId() interface{} Props() *TrafficControlProps }
Represents a `TrafficControl`.
type ITrafficControlBinding ¶ added in v1.6.0
type ITrafficControlBinding interface { alicloudroscdkcore.IResource Props() *TrafficControlBindingProps }
Represents a `TrafficControlBinding`.
type IVpcAccessConfig ¶ added in v1.6.0
type IVpcAccessConfig interface { alicloudroscdkcore.IResource Props() *VpcAccessConfigProps }
Represents a `VpcAccessConfig`.
type Instance ¶
type Instance interface { alicloudroscdkcore.Resource IInstance // Attribute EgressIpv6Enable: Whether enable egress IPV6. AttrEgressIpv6Enable() interface{} // Attribute InstanceId: Instance ID. AttrInstanceId() interface{} // Attribute InstanceType: Instance type. AttrInstanceType() interface{} // Attribute InternetEgressAddress: Internet egress dddress. AttrInternetEgressAddress() interface{} // Attribute SupportIpv6: Whether support IPV6. AttrSupportIpv6() interface{} // Attribute VpcEgressAddress: VPC network egress address. AttrVpcEgressAddress() interface{} // Attribute VpcIntranetEnable: Whether enable VPC intranet. AttrVpcIntranetEnable() interface{} // Attribute VpcSlbIntranetEnable: Whether enable VPC SLB intranet. AttrVpcSlbIntranetEnable() 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() *InstanceProps 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::ApiGateway::Instance`, which is used to create a dedicated instance.
func NewInstance ¶
func NewInstance(scope alicloudroscdkcore.Construct, id *string, props *InstanceProps, enableResourcePropertyConstraint *bool) Instance
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type InstanceProps ¶
type InstanceProps struct { // Property httpsPolicy: HTTPS security policy. // // Valid values: HTTPS2_TLS1_0, HTTPS2_TLS1_2, HTTPS1_1_TLS1_0. HttpsPolicy interface{} `field:"required" json:"httpsPolicy" yaml:"httpsPolicy"` // Property instanceName: Instance name. InstanceName interface{} `field:"required" json:"instanceName" yaml:"instanceName"` // Property instanceSpec: Instance specification. // // For example: api.s1.small InstanceSpec interface{} `field:"required" json:"instanceSpec" yaml:"instanceSpec"` // Property zoneId: Zone to which the instance belongs. // // For example: cn-beijing-MAZ2(f,g). // Pleas call DescribeZones to get supported zone list. ZoneId interface{} `field:"required" json:"zoneId" yaml:"zoneId"` // Property autoPay: Indicates whether automatic payment is enabled. // // Valid values: // false: Automatic payment is disabled. You need to go to Orders to make the payment once an order is generated. // true: Automatic payment is enabled. The payment is automatically made. // Default true. AutoPay interface{} `field:"optional" json:"autoPay" yaml:"autoPay"` // Property chargeType: The billing method of the router interface. // // Valid values: PrePaid (Subscription), PostPaid (default, Pay-As-You-Go). Default value: PostPaid. ChargeType interface{} `field:"optional" json:"chargeType" yaml:"chargeType"` // Property deletionForce: Whether force delete the instance even if its status is START_FAILED. // // Default value is false. DeletionForce interface{} `field:"optional" json:"deletionForce" yaml:"deletionForce"` // Property duration: Prepaid time period. // // It could be from 1 to 9 when PricingCycle is Month, or 1 to 3 when PricingCycle is Year. Default value is 3. Duration interface{} `field:"optional" json:"duration" yaml:"duration"` // Property pricingCycle: Unit of the payment cycle. // // It could be Month (default) or Year. PricingCycle interface{} `field:"optional" json:"pricingCycle" yaml:"pricingCycle"` // Property tags: Tags to attach to instance. // // Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required. Tags *[]*RosInstance_TagsProperty `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `Instance`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-instance
type LogConfig ¶
type LogConfig interface { alicloudroscdkcore.Resource ILogConfig // Attribute SlsLogStore: Logstore name of SLS. AttrSlsLogStore() interface{} // Attribute SlsProject: Project name of SLS. AttrSlsProject() 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() *LogConfigProps 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::ApiGateway::LogConfig`, which is used to create a log configuration.
func NewLogConfig ¶
func NewLogConfig(scope alicloudroscdkcore.Construct, id *string, props *LogConfigProps, enableResourcePropertyConstraint *bool) LogConfig
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type LogConfigProps ¶
type LogConfigProps struct { // Property slsLogStore: Logstore name of SLS. SlsLogStore interface{} `field:"required" json:"slsLogStore" yaml:"slsLogStore"` // Property slsProject: Project name of SLS. SlsProject interface{} `field:"required" json:"slsProject" yaml:"slsProject"` }
Properties for defining a `LogConfig`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-logconfig
type Plugin ¶
type Plugin interface { alicloudroscdkcore.Resource IPlugin // Attribute Description: The description of the plug-in, which cannot exceed 200 characters. AttrDescription() interface{} // Attribute PluginData: The definition statement of the plug-in. // // Plug-in definition statements in the JSON and YAML formats are supported. AttrPluginData() interface{} // Attribute PluginId: The generated plugin ID. AttrPluginId() interface{} // Attribute PluginName: The name of the plug-in that you want to create. // // It can contain uppercase English letters, lowercase English letters, Chinese characters, numbers, and underscores (). It must be 4 to 50 characters in length and cannot start with an underscore (). AttrPluginName() interface{} // Attribute PluginType: The type of the plug-in. // // Valid values: ipControl: indicates IP address-based access control. trafficControl: indicates throttling. backendSignature: indicates backend signature. jwtAuth: indicates JWT (OpenId Connect). cors: indicates cross-origin resource access (CORS). caching: indicates caching. AttrPluginType() 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::ApiGateway::Plugin`, which is used to create an API Gateway plug-in.
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 ApiId: The api id. AttrApiId() interface{} // Attribute PluginId: The plugin id. 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() *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::ApiGateway::PluginAttachment`, which is used to bind a plug-in to an API.
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 apiId: The ID of the API to which you want to bind the plug-in. ApiId interface{} `field:"required" json:"apiId" yaml:"apiId"` // Property pluginId: The ID of the plugin that you want to bind. PluginId interface{} `field:"required" json:"pluginId" yaml:"pluginId"` // Property stageName: The name of the runtime environment. // // Valid values: // RELEASE: indicates the release environment. // PRE: indicates the pre-release environment. // TEST: indicates the test environment. StageName interface{} `field:"required" json:"stageName" yaml:"stageName"` }
Properties for defining a `PluginAttachment`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-pluginattachment
type PluginProps ¶
type PluginProps struct { // Property pluginData: The definition statement of the plug-in. // // Plug-in definition statements in the JSON and YAML formats are supported. PluginData interface{} `field:"required" json:"pluginData" yaml:"pluginData"` // Property pluginName: The name of the plug-in that you want to create. // // It can contain uppercase English letters, lowercase English letters, Chinese characters, numbers, and underscores (). It must be 4 to 50 characters in length and cannot start with an underscore (). PluginName interface{} `field:"required" json:"pluginName" yaml:"pluginName"` // Property pluginType: The type of the plug-in. // // Valid values: ipControl: indicates IP address-based access control. trafficControl: indicates throttling. backendSignature: indicates backend signature. jwtAuth: indicates JWT (OpenId Connect). cors: indicates cross-origin resource access (CORS). caching: indicates caching. PluginType interface{} `field:"required" json:"pluginType" yaml:"pluginType"` // Property description: The description of the plug-in, which cannot exceed 200 characters. Description interface{} `field:"optional" json:"description" yaml:"description"` // Property tags: Tags to attach to instance. // // Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required. Tags *[]*RosPlugin_TagsProperty `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `Plugin`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-plugin
type RosApi ¶
type RosApi interface { alicloudroscdkcore.RosResource AllowSignatureMethod() interface{} SetAllowSignatureMethod(val interface{}) ApiName() interface{} SetApiName(val interface{}) AppCodeAuthType() interface{} SetAppCodeAuthType(val interface{}) AttrApiId() alicloudroscdkcore.IResolvable AuthType() interface{} SetAuthType(val interface{}) ConstParameters() interface{} SetConstParameters(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{}) DisableInternet() interface{} SetDisableInternet(val interface{}) EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) ErrorCodeSamples() interface{} SetErrorCodeSamples(val interface{}) FailResultSample() interface{} SetFailResultSample(val interface{}) ForceNonceCheck() interface{} SetForceNonceCheck(val interface{}) GroupId() interface{} SetGroupId(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 OpenIdConnectConfig() interface{} SetOpenIdConnectConfig(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 RequestConfig() interface{} SetRequestConfig(val interface{}) RequestParameters() interface{} SetRequestParameters(val interface{}) ResultBodyModel() interface{} SetResultBodyModel(val interface{}) ResultDescriptions() interface{} SetResultDescriptions(val interface{}) ResultSample() interface{} SetResultSample(val interface{}) ResultType() interface{} SetResultType(val interface{}) // Options for this resource, such as condition, update policy etc. RosOptions() alicloudroscdkcore.IRosResourceOptions RosProperties() *map[string]interface{} // ROS resource type. RosResourceType() *string ServiceConfig() interface{} SetServiceConfig(val interface{}) ServiceParameters() interface{} SetServiceParameters(val interface{}) ServiceParametersMap() interface{} SetServiceParametersMap(val interface{}) // The stack in which this element is defined. // // RosElements must be defined within a stack scope (directly or indirectly). Stack() alicloudroscdkcore.Stack SystemParameters() interface{} SetSystemParameters(val interface{}) Tags() *[]*RosApi_TagsProperty SetTags(val *[]*RosApi_TagsProperty) // 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{} Visibility() interface{} SetVisibility(val interface{}) WebSocketApiType() interface{} SetWebSocketApiType(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::ApiGateway::Api`, which is used to create an API.
func NewRosApi ¶
func NewRosApi(scope alicloudroscdkcore.Construct, id *string, props *RosApiProps, enableResourcePropertyConstraint *bool) RosApi
type RosApiProps ¶
type RosApiProps struct { ApiName interface{} `field:"required" json:"apiName" yaml:"apiName"` GroupId interface{} `field:"required" json:"groupId" yaml:"groupId"` RequestConfig interface{} `field:"required" json:"requestConfig" yaml:"requestConfig"` ServiceConfig interface{} `field:"required" json:"serviceConfig" yaml:"serviceConfig"` Visibility interface{} `field:"required" json:"visibility" yaml:"visibility"` AllowSignatureMethod interface{} `field:"optional" json:"allowSignatureMethod" yaml:"allowSignatureMethod"` AppCodeAuthType interface{} `field:"optional" json:"appCodeAuthType" yaml:"appCodeAuthType"` AuthType interface{} `field:"optional" json:"authType" yaml:"authType"` ConstParameters interface{} `field:"optional" json:"constParameters" yaml:"constParameters"` Description interface{} `field:"optional" json:"description" yaml:"description"` DisableInternet interface{} `field:"optional" json:"disableInternet" yaml:"disableInternet"` ErrorCodeSamples interface{} `field:"optional" json:"errorCodeSamples" yaml:"errorCodeSamples"` FailResultSample interface{} `field:"optional" json:"failResultSample" yaml:"failResultSample"` ForceNonceCheck interface{} `field:"optional" json:"forceNonceCheck" yaml:"forceNonceCheck"` OpenIdConnectConfig interface{} `field:"optional" json:"openIdConnectConfig" yaml:"openIdConnectConfig"` RequestParameters interface{} `field:"optional" json:"requestParameters" yaml:"requestParameters"` ResultBodyModel interface{} `field:"optional" json:"resultBodyModel" yaml:"resultBodyModel"` ResultDescriptions interface{} `field:"optional" json:"resultDescriptions" yaml:"resultDescriptions"` ResultSample interface{} `field:"optional" json:"resultSample" yaml:"resultSample"` ResultType interface{} `field:"optional" json:"resultType" yaml:"resultType"` ServiceParameters interface{} `field:"optional" json:"serviceParameters" yaml:"serviceParameters"` ServiceParametersMap interface{} `field:"optional" json:"serviceParametersMap" yaml:"serviceParametersMap"` SystemParameters interface{} `field:"optional" json:"systemParameters" yaml:"systemParameters"` Tags *[]*RosApi_TagsProperty `field:"optional" json:"tags" yaml:"tags"` WebSocketApiType interface{} `field:"optional" json:"webSocketApiType" yaml:"webSocketApiType"` }
Properties for defining a `RosApi`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-api
type RosApi_ConstParametersProperty ¶
type RosApi_ConstParametersProperty struct { ConstValue interface{} `field:"required" json:"constValue" yaml:"constValue"` Location interface{} `field:"required" json:"location" yaml:"location"` ServiceParameterName interface{} `field:"required" json:"serviceParameterName" yaml:"serviceParameterName"` Description interface{} `field:"optional" json:"description" yaml:"description"` }
type RosApi_ErrorCodeSamplesProperty ¶
type RosApi_ErrorCodeSamplesProperty struct { Code interface{} `field:"required" json:"code" yaml:"code"` Message interface{} `field:"required" json:"message" yaml:"message"` Description interface{} `field:"optional" json:"description" yaml:"description"` }
type RosApi_FunctionComputeConfigProperty ¶
type RosApi_FunctionComputeConfigProperty struct { ContentTypeCatagory interface{} `field:"optional" json:"contentTypeCatagory" yaml:"contentTypeCatagory"` ContentTypeValue interface{} `field:"optional" json:"contentTypeValue" yaml:"contentTypeValue"` FcBaseUrl interface{} `field:"optional" json:"fcBaseUrl" yaml:"fcBaseUrl"` FcRegionId interface{} `field:"optional" json:"fcRegionId" yaml:"fcRegionId"` FcType interface{} `field:"optional" json:"fcType" yaml:"fcType"` FcVersion interface{} `field:"optional" json:"fcVersion" yaml:"fcVersion"` FunctionName interface{} `field:"optional" json:"functionName" yaml:"functionName"` Method interface{} `field:"optional" json:"method" yaml:"method"` OnlyBusinessPath interface{} `field:"optional" json:"onlyBusinessPath" yaml:"onlyBusinessPath"` Path interface{} `field:"optional" json:"path" yaml:"path"` Qualifier interface{} `field:"optional" json:"qualifier" yaml:"qualifier"` RoleArn interface{} `field:"optional" json:"roleArn" yaml:"roleArn"` ServiceName interface{} `field:"optional" json:"serviceName" yaml:"serviceName"` }
type RosApi_MockHeadersProperty ¶
type RosApi_MockHeadersProperty struct { HeaderName interface{} `field:"required" json:"headerName" yaml:"headerName"` HeaderValue interface{} `field:"required" json:"headerValue" yaml:"headerValue"` }
type RosApi_OpenIdConnectConfigProperty ¶
type RosApi_OpenIdConnectConfigProperty struct { OpenIdApiType interface{} `field:"required" json:"openIdApiType" yaml:"openIdApiType"` IdTokenParamName interface{} `field:"optional" json:"idTokenParamName" yaml:"idTokenParamName"` PublicKey interface{} `field:"optional" json:"publicKey" yaml:"publicKey"` PublicKeyId interface{} `field:"optional" json:"publicKeyId" yaml:"publicKeyId"` }
type RosApi_RequestConfigProperty ¶
type RosApi_RequestConfigProperty struct { RequestHttpMethod interface{} `field:"required" json:"requestHttpMethod" yaml:"requestHttpMethod"` RequestMode interface{} `field:"required" json:"requestMode" yaml:"requestMode"` RequestPath interface{} `field:"required" json:"requestPath" yaml:"requestPath"` RequestProtocol interface{} `field:"required" json:"requestProtocol" yaml:"requestProtocol"` BodyFormat interface{} `field:"optional" json:"bodyFormat" yaml:"bodyFormat"` PostBodyDescription interface{} `field:"optional" json:"postBodyDescription" yaml:"postBodyDescription"` }
type RosApi_RequestParametersProperty ¶
type RosApi_RequestParametersProperty struct { ApiParameterName interface{} `field:"required" json:"apiParameterName" yaml:"apiParameterName"` Location interface{} `field:"required" json:"location" yaml:"location"` ParameterType interface{} `field:"required" json:"parameterType" yaml:"parameterType"` Required interface{} `field:"required" json:"required" yaml:"required"` DefaultValue interface{} `field:"optional" json:"defaultValue" yaml:"defaultValue"` DemoValue interface{} `field:"optional" json:"demoValue" yaml:"demoValue"` Description interface{} `field:"optional" json:"description" yaml:"description"` DocOrder interface{} `field:"optional" json:"docOrder" yaml:"docOrder"` DocShow interface{} `field:"optional" json:"docShow" yaml:"docShow"` EnumValue interface{} `field:"optional" json:"enumValue" yaml:"enumValue"` JsonScheme interface{} `field:"optional" json:"jsonScheme" yaml:"jsonScheme"` MaxLength interface{} `field:"optional" json:"maxLength" yaml:"maxLength"` MaxValue interface{} `field:"optional" json:"maxValue" yaml:"maxValue"` MinLength interface{} `field:"optional" json:"minLength" yaml:"minLength"` MinValue interface{} `field:"optional" json:"minValue" yaml:"minValue"` RegularExpression interface{} `field:"optional" json:"regularExpression" yaml:"regularExpression"` }
type RosApi_ServiceConfigProperty ¶
type RosApi_ServiceConfigProperty struct { ContentTypeCatagory interface{} `field:"optional" json:"contentTypeCatagory" yaml:"contentTypeCatagory"` ContentTypeValue interface{} `field:"optional" json:"contentTypeValue" yaml:"contentTypeValue"` FunctionComputeConfig interface{} `field:"optional" json:"functionComputeConfig" yaml:"functionComputeConfig"` Mock interface{} `field:"optional" json:"mock" yaml:"mock"` MockHeaders interface{} `field:"optional" json:"mockHeaders" yaml:"mockHeaders"` MockResult interface{} `field:"optional" json:"mockResult" yaml:"mockResult"` MockStatusCode interface{} `field:"optional" json:"mockStatusCode" yaml:"mockStatusCode"` ServiceAddress interface{} `field:"optional" json:"serviceAddress" yaml:"serviceAddress"` ServiceHttpMethod interface{} `field:"optional" json:"serviceHttpMethod" yaml:"serviceHttpMethod"` ServicePath interface{} `field:"optional" json:"servicePath" yaml:"servicePath"` ServiceProtocol interface{} `field:"optional" json:"serviceProtocol" yaml:"serviceProtocol"` ServiceTimeOut interface{} `field:"optional" json:"serviceTimeOut" yaml:"serviceTimeOut"` ServiceVpcEnable interface{} `field:"optional" json:"serviceVpcEnable" yaml:"serviceVpcEnable"` VpcConfig interface{} `field:"optional" json:"vpcConfig" yaml:"vpcConfig"` }
type RosApi_ServiceParametersMapProperty ¶
type RosApi_ServiceParametersMapProperty struct { RequestParameterName interface{} `field:"required" json:"requestParameterName" yaml:"requestParameterName"` ServiceParameterName interface{} `field:"required" json:"serviceParameterName" yaml:"serviceParameterName"` }
type RosApi_ServiceParametersProperty ¶
type RosApi_ServiceParametersProperty struct { Location interface{} `field:"required" json:"location" yaml:"location"` ParameterType interface{} `field:"required" json:"parameterType" yaml:"parameterType"` ServiceParameterName interface{} `field:"required" json:"serviceParameterName" yaml:"serviceParameterName"` }
type RosApi_SystemParametersProperty ¶
type RosApi_SystemParametersProperty struct { Location interface{} `field:"required" json:"location" yaml:"location"` ParameterName interface{} `field:"required" json:"parameterName" yaml:"parameterName"` ServiceParameterName interface{} `field:"required" json:"serviceParameterName" yaml:"serviceParameterName"` DemoValue interface{} `field:"optional" json:"demoValue" yaml:"demoValue"` Description interface{} `field:"optional" json:"description" yaml:"description"` }
type RosApi_TagsProperty ¶
type RosApi_TagsProperty struct { Key interface{} `field:"required" json:"key" yaml:"key"` Value interface{} `field:"optional" json:"value" yaml:"value"` }
type RosApi_VpcConfigProperty ¶
type RosApi_VpcConfigProperty struct { InstanceId interface{} `field:"required" json:"instanceId" yaml:"instanceId"` Port interface{} `field:"required" json:"port" yaml:"port"` VpcId interface{} `field:"required" json:"vpcId" yaml:"vpcId"` }
type RosApp ¶
type RosApp interface { alicloudroscdkcore.RosResource AppCode() interface{} SetAppCode(val interface{}) AppKey() interface{} SetAppKey(val interface{}) AppName() interface{} SetAppName(val interface{}) AppSecret() interface{} SetAppSecret(val interface{}) AttrAppCode() alicloudroscdkcore.IResolvable AttrAppId() alicloudroscdkcore.IResolvable AttrAppKey() alicloudroscdkcore.IResolvable AttrAppSecret() alicloudroscdkcore.IResolvable AttrTags() 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) // 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 Tags() *[]*RosApp_TagsProperty SetTags(val *[]*RosApp_TagsProperty) // 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::ApiGateway::App`, which is used to create an application.
Before you call a third-party API, you must create an application and use the application as an identity to call the API.
func NewRosApp ¶
func NewRosApp(scope alicloudroscdkcore.Construct, id *string, props *RosAppProps, enableResourcePropertyConstraint *bool) RosApp
type RosAppProps ¶
type RosAppProps struct { AppName interface{} `field:"required" json:"appName" yaml:"appName"` AppCode interface{} `field:"optional" json:"appCode" yaml:"appCode"` AppKey interface{} `field:"optional" json:"appKey" yaml:"appKey"` AppSecret interface{} `field:"optional" json:"appSecret" yaml:"appSecret"` Description interface{} `field:"optional" json:"description" yaml:"description"` Tags *[]*RosApp_TagsProperty `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `RosApp`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-app
type RosApp_TagsProperty ¶
type RosApp_TagsProperty struct { Key interface{} `field:"required" json:"key" yaml:"key"` Value interface{} `field:"optional" json:"value" yaml:"value"` }
type RosAuthorization ¶
type RosAuthorization interface { alicloudroscdkcore.RosResource ApiIds() interface{} SetApiIds(val interface{}) AppIds() interface{} SetAppIds(val interface{}) AuthValidTime() interface{} SetAuthValidTime(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) GroupId() interface{} SetGroupId(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 StageName() interface{} SetStageName(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::ApiGateway::Authorization`, which is used to authorize applications to call APIs.
func NewRosAuthorization ¶
func NewRosAuthorization(scope alicloudroscdkcore.Construct, id *string, props *RosAuthorizationProps, enableResourcePropertyConstraint *bool) RosAuthorization
type RosAuthorizationProps ¶
type RosAuthorizationProps struct { ApiIds interface{} `field:"required" json:"apiIds" yaml:"apiIds"` AppIds interface{} `field:"required" json:"appIds" yaml:"appIds"` GroupId interface{} `field:"required" json:"groupId" yaml:"groupId"` StageName interface{} `field:"required" json:"stageName" yaml:"stageName"` AuthValidTime interface{} `field:"optional" json:"authValidTime" yaml:"authValidTime"` Description interface{} `field:"optional" json:"description" yaml:"description"` }
Properties for defining a `RosAuthorization`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-authorization
type RosCustomDomain ¶
type RosCustomDomain interface { alicloudroscdkcore.RosResource AttrCertificateId() alicloudroscdkcore.IResolvable CertificateBody() interface{} SetCertificateBody(val interface{}) CertificateName() interface{} SetCertificateName(val interface{}) CertificatePrivateKey() interface{} SetCertificatePrivateKey(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 DomainName() interface{} SetDomainName(val interface{}) EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) GroupId() interface{} SetGroupId(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::ApiGateway::CustomDomain`, which is used to bind a custom domain name and upload a Secure Sockets Layer (SSL) certificate to a specific API group.
func NewRosCustomDomain ¶
func NewRosCustomDomain(scope alicloudroscdkcore.Construct, id *string, props *RosCustomDomainProps, enableResourcePropertyConstraint *bool) RosCustomDomain
type RosCustomDomainProps ¶
type RosCustomDomainProps struct { DomainName interface{} `field:"required" json:"domainName" yaml:"domainName"` GroupId interface{} `field:"required" json:"groupId" yaml:"groupId"` CertificateBody interface{} `field:"optional" json:"certificateBody" yaml:"certificateBody"` CertificateName interface{} `field:"optional" json:"certificateName" yaml:"certificateName"` CertificatePrivateKey interface{} `field:"optional" json:"certificatePrivateKey" yaml:"certificatePrivateKey"` }
Properties for defining a `RosCustomDomain`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-customdomain
type RosDeployment ¶
type RosDeployment interface { alicloudroscdkcore.RosResource ApiId() interface{} SetApiId(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) GroupId() interface{} SetGroupId(val interface{}) HistoryVersion() interface{} SetHistoryVersion(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 StageName() interface{} SetStageName(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::ApiGateway::Deployment`, which is used to publish an API to a specific runtime environment, or switch a published API to a specific version.
func NewRosDeployment ¶
func NewRosDeployment(scope alicloudroscdkcore.Construct, id *string, props *RosDeploymentProps, enableResourcePropertyConstraint *bool) RosDeployment
type RosDeploymentProps ¶
type RosDeploymentProps struct { ApiId interface{} `field:"required" json:"apiId" yaml:"apiId"` GroupId interface{} `field:"required" json:"groupId" yaml:"groupId"` StageName interface{} `field:"required" json:"stageName" yaml:"stageName"` Description interface{} `field:"optional" json:"description" yaml:"description"` HistoryVersion interface{} `field:"optional" json:"historyVersion" yaml:"historyVersion"` }
Properties for defining a `RosDeployment`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-deployment
type RosGroup ¶
type RosGroup interface { alicloudroscdkcore.RosResource AttrGroupId() alicloudroscdkcore.IResolvable AttrSubDomain() alicloudroscdkcore.IResolvable AttrTags() 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) GroupName() interface{} SetGroupName(val interface{}) InstanceId() interface{} SetInstanceId(val interface{}) InternetEnable() interface{} SetInternetEnable(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 PassthroughHeaders() interface{} SetPassthroughHeaders(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 Tags() *[]*RosGroup_TagsProperty SetTags(val *[]*RosGroup_TagsProperty) // 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{} VpcIntranetEnable() interface{} SetVpcIntranetEnable(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::ApiGateway::Group`, which is used to create an API group.
func NewRosGroup ¶
func NewRosGroup(scope alicloudroscdkcore.Construct, id *string, props *RosGroupProps, enableResourcePropertyConstraint *bool) RosGroup
type RosGroupProps ¶
type RosGroupProps struct { GroupName interface{} `field:"required" json:"groupName" yaml:"groupName"` BasePath interface{} `field:"optional" json:"basePath" yaml:"basePath"` Description interface{} `field:"optional" json:"description" yaml:"description"` InstanceId interface{} `field:"optional" json:"instanceId" yaml:"instanceId"` InternetEnable interface{} `field:"optional" json:"internetEnable" yaml:"internetEnable"` PassthroughHeaders interface{} `field:"optional" json:"passthroughHeaders" yaml:"passthroughHeaders"` Tags *[]*RosGroup_TagsProperty `field:"optional" json:"tags" yaml:"tags"` VpcIntranetEnable interface{} `field:"optional" json:"vpcIntranetEnable" yaml:"vpcIntranetEnable"` }
Properties for defining a `RosGroup`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-group
type RosGroup_TagsProperty ¶
type RosGroup_TagsProperty struct { Key interface{} `field:"required" json:"key" yaml:"key"` Value interface{} `field:"optional" json:"value" yaml:"value"` }
type RosInstance ¶
type RosInstance interface { alicloudroscdkcore.RosResource AttrEgressIpv6Enable() alicloudroscdkcore.IResolvable AttrInstanceId() alicloudroscdkcore.IResolvable AttrInstanceType() alicloudroscdkcore.IResolvable AttrInternetEgressAddress() alicloudroscdkcore.IResolvable AttrSupportIpv6() alicloudroscdkcore.IResolvable AttrVpcEgressAddress() alicloudroscdkcore.IResolvable AttrVpcIntranetEnable() alicloudroscdkcore.IResolvable AttrVpcSlbIntranetEnable() alicloudroscdkcore.IResolvable AutoPay() interface{} SetAutoPay(val interface{}) ChargeType() interface{} SetChargeType(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 DeletionForce() interface{} SetDeletionForce(val interface{}) Duration() interface{} SetDuration(val interface{}) EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) HttpsPolicy() interface{} SetHttpsPolicy(val interface{}) InstanceName() interface{} SetInstanceName(val interface{}) InstanceSpec() interface{} SetInstanceSpec(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 PricingCycle() interface{} SetPricingCycle(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 Tags() *[]*RosInstance_TagsProperty SetTags(val *[]*RosInstance_TagsProperty) // 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{} ZoneId() interface{} SetZoneId(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::ApiGateway::Instance`, which is used to create a dedicated instance.
func NewRosInstance ¶
func NewRosInstance(scope alicloudroscdkcore.Construct, id *string, props *RosInstanceProps, enableResourcePropertyConstraint *bool) RosInstance
type RosInstanceProps ¶
type RosInstanceProps struct { HttpsPolicy interface{} `field:"required" json:"httpsPolicy" yaml:"httpsPolicy"` InstanceName interface{} `field:"required" json:"instanceName" yaml:"instanceName"` InstanceSpec interface{} `field:"required" json:"instanceSpec" yaml:"instanceSpec"` ZoneId interface{} `field:"required" json:"zoneId" yaml:"zoneId"` AutoPay interface{} `field:"optional" json:"autoPay" yaml:"autoPay"` ChargeType interface{} `field:"optional" json:"chargeType" yaml:"chargeType"` DeletionForce interface{} `field:"optional" json:"deletionForce" yaml:"deletionForce"` Duration interface{} `field:"optional" json:"duration" yaml:"duration"` PricingCycle interface{} `field:"optional" json:"pricingCycle" yaml:"pricingCycle"` Tags *[]*RosInstance_TagsProperty `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `RosInstance`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-instance
type RosInstance_TagsProperty ¶
type RosInstance_TagsProperty struct { Key interface{} `field:"required" json:"key" yaml:"key"` Value interface{} `field:"optional" json:"value" yaml:"value"` }
type RosLogConfig ¶
type RosLogConfig interface { alicloudroscdkcore.RosResource AttrSlsLogStore() alicloudroscdkcore.IResolvable AttrSlsProject() 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) // 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 SlsLogStore() interface{} SetSlsLogStore(val interface{}) SlsProject() interface{} SetSlsProject(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::ApiGateway::LogConfig`, which is used to create a log configuration.
func NewRosLogConfig ¶
func NewRosLogConfig(scope alicloudroscdkcore.Construct, id *string, props *RosLogConfigProps, enableResourcePropertyConstraint *bool) RosLogConfig
type RosLogConfigProps ¶
type RosLogConfigProps struct { SlsLogStore interface{} `field:"required" json:"slsLogStore" yaml:"slsLogStore"` SlsProject interface{} `field:"required" json:"slsProject" yaml:"slsProject"` }
Properties for defining a `RosLogConfig`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-logconfig
type RosPlugin ¶
type RosPlugin interface { alicloudroscdkcore.RosResource AttrDescription() alicloudroscdkcore.IResolvable AttrPluginData() alicloudroscdkcore.IResolvable AttrPluginId() alicloudroscdkcore.IResolvable AttrPluginName() alicloudroscdkcore.IResolvable AttrPluginType() 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) // 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 PluginData() interface{} SetPluginData(val interface{}) PluginName() interface{} SetPluginName(val interface{}) PluginType() interface{} SetPluginType(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 Tags() *[]*RosPlugin_TagsProperty SetTags(val *[]*RosPlugin_TagsProperty) // 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::ApiGateway::Plugin`, which is used to create an API Gateway plug-in.
func NewRosPlugin ¶
func NewRosPlugin(scope alicloudroscdkcore.Construct, id *string, props *RosPluginProps, enableResourcePropertyConstraint *bool) RosPlugin
type RosPluginAttachment ¶
type RosPluginAttachment interface { alicloudroscdkcore.RosResource ApiId() interface{} SetApiId(val interface{}) AttrApiId() 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) // 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 PluginId() interface{} SetPluginId(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 StageName() interface{} SetStageName(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::ApiGateway::PluginAttachment`, which is used to bind a plug-in to an API.
func NewRosPluginAttachment ¶
func NewRosPluginAttachment(scope alicloudroscdkcore.Construct, id *string, props *RosPluginAttachmentProps, enableResourcePropertyConstraint *bool) RosPluginAttachment
type RosPluginAttachmentProps ¶
type RosPluginAttachmentProps struct { ApiId interface{} `field:"required" json:"apiId" yaml:"apiId"` PluginId interface{} `field:"required" json:"pluginId" yaml:"pluginId"` StageName interface{} `field:"required" json:"stageName" yaml:"stageName"` }
Properties for defining a `RosPluginAttachment`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-pluginattachment
type RosPluginProps ¶
type RosPluginProps struct { PluginData interface{} `field:"required" json:"pluginData" yaml:"pluginData"` PluginName interface{} `field:"required" json:"pluginName" yaml:"pluginName"` PluginType interface{} `field:"required" json:"pluginType" yaml:"pluginType"` Description interface{} `field:"optional" json:"description" yaml:"description"` Tags *[]*RosPlugin_TagsProperty `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `RosPlugin`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-plugin
type RosPlugin_TagsProperty ¶
type RosPlugin_TagsProperty struct { Key interface{} `field:"required" json:"key" yaml:"key"` Value interface{} `field:"optional" json:"value" yaml:"value"` }
type RosSignature ¶
type RosSignature interface { alicloudroscdkcore.RosResource AttrSignatureId() 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) // 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 SignatureKey() interface{} SetSignatureKey(val interface{}) SignatureName() interface{} SetSignatureName(val interface{}) SignatureSecret() interface{} SetSignatureSecret(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::ApiGateway::Signature`, which is used to create a backend signature.
func NewRosSignature ¶
func NewRosSignature(scope alicloudroscdkcore.Construct, id *string, props *RosSignatureProps, enableResourcePropertyConstraint *bool) RosSignature
type RosSignatureBinding ¶
type RosSignatureBinding interface { alicloudroscdkcore.RosResource ApiIds() interface{} SetApiIds(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 EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) GroupId() interface{} SetGroupId(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 SignatureId() interface{} SetSignatureId(val interface{}) // The stack in which this element is defined. // // RosElements must be defined within a stack scope (directly or indirectly). Stack() alicloudroscdkcore.Stack StageName() interface{} SetStageName(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::ApiGateway::SignatureBinding`, which is used to bind a backend signature to APIs.
func NewRosSignatureBinding ¶
func NewRosSignatureBinding(scope alicloudroscdkcore.Construct, id *string, props *RosSignatureBindingProps, enableResourcePropertyConstraint *bool) RosSignatureBinding
type RosSignatureBindingProps ¶
type RosSignatureBindingProps struct { ApiIds interface{} `field:"required" json:"apiIds" yaml:"apiIds"` GroupId interface{} `field:"required" json:"groupId" yaml:"groupId"` SignatureId interface{} `field:"required" json:"signatureId" yaml:"signatureId"` StageName interface{} `field:"required" json:"stageName" yaml:"stageName"` }
Properties for defining a `RosSignatureBinding`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-signaturebinding
type RosSignatureProps ¶
type RosSignatureProps struct { SignatureKey interface{} `field:"required" json:"signatureKey" yaml:"signatureKey"` SignatureName interface{} `field:"required" json:"signatureName" yaml:"signatureName"` SignatureSecret interface{} `field:"required" json:"signatureSecret" yaml:"signatureSecret"` }
Properties for defining a `RosSignature`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-signature
type RosStageConfig ¶
type RosStageConfig interface { alicloudroscdkcore.RosResource // 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) GroupId() interface{} SetGroupId(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 StageName() interface{} SetStageName(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{} Variables() interface{} SetVariables(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::ApiGateway::StageConfig`, which is used to configure the test, staging, or production environment variables for an API group.
func NewRosStageConfig ¶
func NewRosStageConfig(scope alicloudroscdkcore.Construct, id *string, props *RosStageConfigProps, enableResourcePropertyConstraint *bool) RosStageConfig
type RosStageConfigProps ¶
type RosStageConfigProps struct { GroupId interface{} `field:"required" json:"groupId" yaml:"groupId"` StageName interface{} `field:"required" json:"stageName" yaml:"stageName"` Variables interface{} `field:"required" json:"variables" yaml:"variables"` }
Properties for defining a `RosStageConfig`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-stageconfig
type RosTrafficControl ¶
type RosTrafficControl interface { alicloudroscdkcore.RosResource ApiDefault() interface{} SetApiDefault(val interface{}) AppDefault() interface{} SetAppDefault(val interface{}) AttrTrafficControlId() 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) // 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 Special() interface{} SetSpecial(val interface{}) // The stack in which this element is defined. // // RosElements must be defined within a stack scope (directly or indirectly). Stack() alicloudroscdkcore.Stack TrafficControlName() interface{} SetTrafficControlName(val interface{}) TrafficControlUnit() interface{} SetTrafficControlUnit(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{} UserDefault() interface{} SetUserDefault(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::ApiGateway::TrafficControl`, which is used to create a custom throttling policy.
func NewRosTrafficControl ¶
func NewRosTrafficControl(scope alicloudroscdkcore.Construct, id *string, props *RosTrafficControlProps, enableResourcePropertyConstraint *bool) RosTrafficControl
type RosTrafficControlBinding ¶
type RosTrafficControlBinding interface { alicloudroscdkcore.RosResource ApiIds() interface{} SetApiIds(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 EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) GroupId() interface{} SetGroupId(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 StageName() interface{} SetStageName(val interface{}) TrafficControlId() interface{} SetTrafficControlId(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::ApiGateway::TrafficControlBinding`, which is used to bind a custom throttling policy to APIs.
func NewRosTrafficControlBinding ¶
func NewRosTrafficControlBinding(scope alicloudroscdkcore.Construct, id *string, props *RosTrafficControlBindingProps, enableResourcePropertyConstraint *bool) RosTrafficControlBinding
type RosTrafficControlBindingProps ¶
type RosTrafficControlBindingProps struct { ApiIds interface{} `field:"required" json:"apiIds" yaml:"apiIds"` GroupId interface{} `field:"required" json:"groupId" yaml:"groupId"` StageName interface{} `field:"required" json:"stageName" yaml:"stageName"` TrafficControlId interface{} `field:"required" json:"trafficControlId" yaml:"trafficControlId"` }
Properties for defining a `RosTrafficControlBinding`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-trafficcontrolbinding
type RosTrafficControlProps ¶
type RosTrafficControlProps struct { ApiDefault interface{} `field:"required" json:"apiDefault" yaml:"apiDefault"` TrafficControlName interface{} `field:"required" json:"trafficControlName" yaml:"trafficControlName"` TrafficControlUnit interface{} `field:"required" json:"trafficControlUnit" yaml:"trafficControlUnit"` AppDefault interface{} `field:"optional" json:"appDefault" yaml:"appDefault"` Description interface{} `field:"optional" json:"description" yaml:"description"` Special interface{} `field:"optional" json:"special" yaml:"special"` UserDefault interface{} `field:"optional" json:"userDefault" yaml:"userDefault"` }
Properties for defining a `RosTrafficControl`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-trafficcontrol
type RosTrafficControl_SpecialProperty ¶
type RosTrafficControl_SpecialProperty struct { SpecialKey interface{} `field:"required" json:"specialKey" yaml:"specialKey"` SpecialType interface{} `field:"required" json:"specialType" yaml:"specialType"` TrafficValue interface{} `field:"required" json:"trafficValue" yaml:"trafficValue"` }
type RosVpcAccessConfig ¶
type RosVpcAccessConfig interface { alicloudroscdkcore.RosResource // 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) InstanceId() interface{} SetInstanceId(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 Name() interface{} SetName(val interface{}) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode Port() interface{} SetPort(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{} VpcId() interface{} SetVpcId(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::ApiGateway::VpcAccessConfig`, which is used to configure virtual private cloud (VPC) access authorization for an instance.
This helps APIs provide services based on private networks.
func NewRosVpcAccessConfig ¶
func NewRosVpcAccessConfig(scope alicloudroscdkcore.Construct, id *string, props *RosVpcAccessConfigProps, enableResourcePropertyConstraint *bool) RosVpcAccessConfig
type RosVpcAccessConfigProps ¶
type RosVpcAccessConfigProps struct { InstanceId interface{} `field:"required" json:"instanceId" yaml:"instanceId"` Name interface{} `field:"required" json:"name" yaml:"name"` Port interface{} `field:"required" json:"port" yaml:"port"` VpcId interface{} `field:"required" json:"vpcId" yaml:"vpcId"` }
Properties for defining a `RosVpcAccessConfig`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-vpcaccessconfig
type Signature ¶
type Signature interface { alicloudroscdkcore.Resource ISignature // Attribute SignatureId: The id of the created signature. AttrSignatureId() 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() *SignatureProps 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::ApiGateway::Signature`, which is used to create a backend signature.
func NewSignature ¶
func NewSignature(scope alicloudroscdkcore.Construct, id *string, props *SignatureProps, enableResourcePropertyConstraint *bool) Signature
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type SignatureBinding ¶
type SignatureBinding interface { alicloudroscdkcore.Resource ISignatureBinding 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() *SignatureBindingProps 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::ApiGateway::SignatureBinding`, which is used to bind a backend signature to APIs.
func NewSignatureBinding ¶
func NewSignatureBinding(scope alicloudroscdkcore.Construct, id *string, props *SignatureBindingProps, enableResourcePropertyConstraint *bool) SignatureBinding
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type SignatureBindingProps ¶
type SignatureBindingProps struct { // Property apiIds: APIs to bind with the signature. ApiIds interface{} `field:"required" json:"apiIds" yaml:"apiIds"` // Property groupId: The id of group. GroupId interface{} `field:"required" json:"groupId" yaml:"groupId"` // Property signatureId: The id of the Signature. SignatureId interface{} `field:"required" json:"signatureId" yaml:"signatureId"` // Property stageName: Bind signature in this stage. StageName interface{} `field:"required" json:"stageName" yaml:"stageName"` }
Properties for defining a `SignatureBinding`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-signaturebinding
type SignatureProps ¶
type SignatureProps struct { // Property signatureKey: The key of the signature. SignatureKey interface{} `field:"required" json:"signatureKey" yaml:"signatureKey"` // Property signatureName: The name of the Signature.It must be 4 to 128 characters in length, and can contain letters, digits, underscores (_), dashes (-), spaces and dots (.), It must start with a letter. SignatureName interface{} `field:"required" json:"signatureName" yaml:"signatureName"` // Property signatureSecret: The secret of the signature. SignatureSecret interface{} `field:"required" json:"signatureSecret" yaml:"signatureSecret"` }
Properties for defining a `Signature`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-signature
type StageConfig ¶
type StageConfig interface { alicloudroscdkcore.Resource IStageConfig 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() *StageConfigProps 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::ApiGateway::StageConfig`, which is used to configure the test, staging, or production environment variables for an API group.
func NewStageConfig ¶
func NewStageConfig(scope alicloudroscdkcore.Construct, id *string, props *StageConfigProps, enableResourcePropertyConstraint *bool) StageConfig
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type StageConfigProps ¶
type StageConfigProps struct { // Property groupId: The id of the Group. GroupId interface{} `field:"required" json:"groupId" yaml:"groupId"` // Property stageName: The name of the Stage. StageName interface{} `field:"required" json:"stageName" yaml:"stageName"` // Property variables: Variables in the stage, key-value pairs. Variables interface{} `field:"required" json:"variables" yaml:"variables"` }
Properties for defining a `StageConfig`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-stageconfig
type TrafficControl ¶
type TrafficControl interface { alicloudroscdkcore.Resource ITrafficControl // Attribute TrafficControlId: The id of the traffic control. AttrTrafficControlId() 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() *TrafficControlProps 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::ApiGateway::TrafficControl`, which is used to create a custom throttling policy.
func NewTrafficControl ¶
func NewTrafficControl(scope alicloudroscdkcore.Construct, id *string, props *TrafficControlProps, enableResourcePropertyConstraint *bool) TrafficControl
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type TrafficControlBinding ¶
type TrafficControlBinding interface { alicloudroscdkcore.Resource ITrafficControlBinding 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() *TrafficControlBindingProps 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::ApiGateway::TrafficControlBinding`, which is used to bind a custom throttling policy to APIs.
func NewTrafficControlBinding ¶
func NewTrafficControlBinding(scope alicloudroscdkcore.Construct, id *string, props *TrafficControlBindingProps, enableResourcePropertyConstraint *bool) TrafficControlBinding
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type TrafficControlBindingProps ¶
type TrafficControlBindingProps struct { // Property apiIds: APIs to bind with the traffic control. ApiIds interface{} `field:"required" json:"apiIds" yaml:"apiIds"` // Property groupId: The id of group. GroupId interface{} `field:"required" json:"groupId" yaml:"groupId"` // Property stageName: Bind traffic in this stage. StageName interface{} `field:"required" json:"stageName" yaml:"stageName"` // Property trafficControlId: The id of traffic control. TrafficControlId interface{} `field:"required" json:"trafficControlId" yaml:"trafficControlId"` }
Properties for defining a `TrafficControlBinding`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-trafficcontrolbinding
type TrafficControlProps ¶
type TrafficControlProps struct { // Property apiDefault: Default API traffic value. ApiDefault interface{} `field:"required" json:"apiDefault" yaml:"apiDefault"` // Property trafficControlName: The name of the traffic control.It must be 4 to 128 characters in length, and can contain letters, digits, underscores (_), dashes (-), spaces and dots (.), It must start with a letter. TrafficControlName interface{} `field:"required" json:"trafficControlName" yaml:"trafficControlName"` // Property trafficControlUnit: Traffic control unit, DAY\/HOUR\/MINUTE. TrafficControlUnit interface{} `field:"required" json:"trafficControlUnit" yaml:"trafficControlUnit"` // Property appDefault: Default APP traffic value. AppDefault interface{} `field:"optional" json:"appDefault" yaml:"appDefault"` // Property description: Description of the traffic control, less than 180 characters. Description interface{} `field:"optional" json:"description" yaml:"description"` // Property special: Special traffic controls. Special interface{} `field:"optional" json:"special" yaml:"special"` // Property userDefault: Default user traffic value. UserDefault interface{} `field:"optional" json:"userDefault" yaml:"userDefault"` }
Properties for defining a `TrafficControl`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-trafficcontrol
type VpcAccessConfig ¶
type VpcAccessConfig interface { alicloudroscdkcore.Resource IVpcAccessConfig 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() *VpcAccessConfigProps 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::ApiGateway::VpcAccessConfig`, which is used to configure virtual private cloud (VPC) access authorization for an instance.
This helps APIs provide services based on private networks.
func NewVpcAccessConfig ¶
func NewVpcAccessConfig(scope alicloudroscdkcore.Construct, id *string, props *VpcAccessConfigProps, enableResourcePropertyConstraint *bool) VpcAccessConfig
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type VpcAccessConfigProps ¶
type VpcAccessConfigProps struct { // Property instanceId: The id of the instance (ECS\/SLB\/ALB\/NLB). InstanceId interface{} `field:"required" json:"instanceId" yaml:"instanceId"` // Property name: The name of one VPC access configuration. Name interface{} `field:"required" json:"name" yaml:"name"` // Property port: The port of the VPC. Port interface{} `field:"required" json:"port" yaml:"port"` // Property vpcId: The id of the VPC. VpcId interface{} `field:"required" json:"vpcId" yaml:"vpcId"` }
Properties for defining a `VpcAccessConfig`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-vpcaccessconfig
Source Files ¶
- Api.go
- ApiProps.go
- Api__checks.go
- App.go
- AppProps.go
- App__checks.go
- Authorization.go
- AuthorizationProps.go
- Authorization__checks.go
- CustomDomain.go
- CustomDomainProps.go
- CustomDomain__checks.go
- Deployment.go
- DeploymentProps.go
- Deployment__checks.go
- Group.go
- GroupProps.go
- Group__checks.go
- IApi.go
- IApp.go
- IAuthorization.go
- ICustomDomain.go
- IDeployment.go
- IGroup.go
- IInstance.go
- ILogConfig.go
- IPlugin.go
- IPluginAttachment.go
- ISignature.go
- ISignatureBinding.go
- IStageConfig.go
- ITrafficControl.go
- ITrafficControlBinding.go
- IVpcAccessConfig.go
- Instance.go
- InstanceProps.go
- Instance__checks.go
- LogConfig.go
- LogConfigProps.go
- LogConfig__checks.go
- Plugin.go
- PluginAttachment.go
- PluginAttachmentProps.go
- PluginAttachment__checks.go
- PluginProps.go
- Plugin__checks.go
- RosApi.go
- RosApiProps.go
- RosApi_ConstParametersProperty.go
- RosApi_ErrorCodeSamplesProperty.go
- RosApi_FunctionComputeConfigProperty.go
- RosApi_MockHeadersProperty.go
- RosApi_OpenIdConnectConfigProperty.go
- RosApi_RequestConfigProperty.go
- RosApi_RequestParametersProperty.go
- RosApi_ServiceConfigProperty.go
- RosApi_ServiceParametersMapProperty.go
- RosApi_ServiceParametersProperty.go
- RosApi_SystemParametersProperty.go
- RosApi_TagsProperty.go
- RosApi_VpcConfigProperty.go
- RosApi__checks.go
- RosApp.go
- RosAppProps.go
- RosApp_TagsProperty.go
- RosApp__checks.go
- RosAuthorization.go
- RosAuthorizationProps.go
- RosAuthorization__checks.go
- RosCustomDomain.go
- RosCustomDomainProps.go
- RosCustomDomain__checks.go
- RosDeployment.go
- RosDeploymentProps.go
- RosDeployment__checks.go
- RosGroup.go
- RosGroupProps.go
- RosGroup_TagsProperty.go
- RosGroup__checks.go
- RosInstance.go
- RosInstanceProps.go
- RosInstance_TagsProperty.go
- RosInstance__checks.go
- RosLogConfig.go
- RosLogConfigProps.go
- RosLogConfig__checks.go
- RosPlugin.go
- RosPluginAttachment.go
- RosPluginAttachmentProps.go
- RosPluginAttachment__checks.go
- RosPluginProps.go
- RosPlugin_TagsProperty.go
- RosPlugin__checks.go
- RosSignature.go
- RosSignatureBinding.go
- RosSignatureBindingProps.go
- RosSignatureBinding__checks.go
- RosSignatureProps.go
- RosSignature__checks.go
- RosStageConfig.go
- RosStageConfigProps.go
- RosStageConfig__checks.go
- RosTrafficControl.go
- RosTrafficControlBinding.go
- RosTrafficControlBindingProps.go
- RosTrafficControlBinding__checks.go
- RosTrafficControlProps.go
- RosTrafficControl_SpecialProperty.go
- RosTrafficControl__checks.go
- RosVpcAccessConfig.go
- RosVpcAccessConfigProps.go
- RosVpcAccessConfig__checks.go
- Signature.go
- SignatureBinding.go
- SignatureBindingProps.go
- SignatureBinding__checks.go
- SignatureProps.go
- Signature__checks.go
- StageConfig.go
- StageConfigProps.go
- StageConfig__checks.go
- TrafficControl.go
- TrafficControlBinding.go
- TrafficControlBindingProps.go
- TrafficControlBinding__checks.go
- TrafficControlProps.go
- TrafficControl__checks.go
- VpcAccessConfig.go
- VpcAccessConfigProps.go
- VpcAccessConfig__checks.go
- main.go
Directories ¶
Path | Synopsis |
---|---|
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.
|
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves. |