Plugin
This class encapsulates and extends the ROS resource type ALIYUN::ApiGateway::Plugin
, which is used to create an API Gateway plug-in.
Initializers
import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkapigateway"
alicloudroscdkapigateway.NewPlugin(scope Construct, id *string, props PluginProps, enableResourcePropertyConstraint *bool) Plugin
Name | Type | Description |
---|---|---|
scope |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct |
No description. |
id |
*string |
No description. |
props |
PluginProps |
No description. |
enableResourcePropertyConstraint |
*bool |
No description. |
scope
Required
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct
id
Required
- Type: *string
props
Required
- Type: PluginProps
enableResourcePropertyConstraint
Optional
- Type: *bool
Methods
Name | Description |
---|---|
ToString |
Returns a string representation of this construct. |
Synthesize |
Allows this construct to emit artifacts into the cloud assembly during synthesis. |
AddCondition |
No description. |
AddCount |
No description. |
AddDependency |
No description. |
AddResourceDesc |
No description. |
ApplyRemovalPolicy |
No description. |
GetAtt |
No description. |
SetMetadata |
No description. |
ToString
func ToString() *string
Returns a string representation of this construct.
Synthesize
func Synthesize(session ISynthesisSession)
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.
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession
The synthesis session.
AddCondition
func AddCondition(condition RosCondition)
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition
AddCount
func AddCount(count interface{})
- Type: interface{}
AddDependency
func AddDependency(resource Resource)
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Resource
AddResourceDesc
func AddResourceDesc(desc *string)
- Type: *string
ApplyRemovalPolicy
func ApplyRemovalPolicy(policy RemovalPolicy)
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy
GetAtt
func GetAtt(name *string) IResolvable
- Type: *string
SetMetadata
func SetMetadata(key *string, value interface{})
- Type: *string
- Type: interface{}
Static Functions
Name | Description |
---|---|
IsConstruct |
Return whether the given object is a Construct. |
IsConstruct
import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkapigateway"
alicloudroscdkapigateway.Plugin_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
- Type: interface{}
Properties
Name | Type | Description |
---|---|---|
Node |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode |
The construct tree node associated with this construct. |
Ref |
*string |
No description. |
Stack |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack |
The stack in which this resource is defined. |
Resource |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource |
No description. |
AttrDescription |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable |
Attribute Description: The description of the plug-in, which cannot exceed 200 characters. |
AttrPluginData |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable |
Attribute PluginData: The definition statement of the plug-in. |
AttrPluginId |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable |
Attribute PluginId: The generated plugin ID. |
AttrPluginName |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable |
Attribute PluginName: The name of the plug-in that you want to create. |
AttrPluginType |
github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable |
Attribute PluginType: The type of the plug-in. |
Node
Required
func Node() ConstructNode
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode
The construct tree node associated with this construct.
Ref
Required
func Ref() *string
- Type: *string
Stack
Required
func Stack() Stack
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack
The stack in which this resource is defined.
Resource
Optional
func Resource() RosResource
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource
AttrDescription
Required
func AttrDescription() IResolvable
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable
Attribute Description: The description of the plug-in, which cannot exceed 200 characters.
AttrPluginData
Required
func AttrPluginData() IResolvable
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable
Attribute PluginData: The definition statement of the plug-in.
Plug-in definition statements in the JSON and YAML formats are supported.
AttrPluginId
Required
func AttrPluginId() IResolvable
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable
Attribute PluginId: The generated plugin ID.
AttrPluginName
Required
func AttrPluginName() IResolvable
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable
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 ().
AttrPluginType
Required
func AttrPluginType() IResolvable
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable
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.