Skip to content

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 ros_cdk_apigateway
ros_cdk_apigateway.Plugin(
  scope: Construct,
  id: str,
  plugin_data: typing.Union[str, IResolvable],
  plugin_name: typing.Union[str, IResolvable],
  plugin_type: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
plugin_data typing.Union[str, ros_cdk_core.IResolvable] Property pluginData: The definition statement of the plug-in.
plugin_name typing.Union[str, ros_cdk_core.IResolvable] Property pluginName: The name of the plug-in that you want to create.
plugin_type typing.Union[str, ros_cdk_core.IResolvable] Property pluginType: The type of the plug-in.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the plug-in, which cannot exceed 200 characters.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

plugin_dataRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property pluginData: The definition statement of the plug-in.

Plug-in definition statements in the JSON and YAML formats are supported.

plugin_nameRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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 ().

plugin_typeRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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.

descriptionOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The description of the plug-in, which cannot exceed 200 characters.

tagsOptional

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.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_apigateway
ros_cdk_apigateway.Plugin.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_description ros_cdk_core.IResolvable Attribute Description: The description of the plug-in, which cannot exceed 200 characters.
attr_plugin_data ros_cdk_core.IResolvable Attribute PluginData: The definition statement of the plug-in.
attr_plugin_id ros_cdk_core.IResolvable Attribute PluginId: The generated plugin ID.
attr_plugin_name ros_cdk_core.IResolvable Attribute PluginName: The name of the plug-in that you want to create.
attr_plugin_type ros_cdk_core.IResolvable Attribute PluginType: The type of the plug-in.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_descriptionRequired 

attr_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Description: The description of the plug-in, which cannot exceed 200 characters.

attr_plugin_dataRequired 

attr_plugin_data: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PluginData: The definition statement of the plug-in.

Plug-in definition statements in the JSON and YAML formats are supported.

attr_plugin_idRequired 

attr_plugin_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PluginId: The generated plugin ID.

attr_plugin_nameRequired 

attr_plugin_name: IResolvable
  • Type: ros_cdk_core.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 ().

attr_plugin_typeRequired 

attr_plugin_type: IResolvable
  • Type: ros_cdk_core.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.