Operation

• Implements: IOperation

This class encapsulates and extends the ROS resource type ALIYUN::APIG::Operation, which is used to create an operation for an HTTP API.

Initializers

import ros_cdk_apig
ros_cdk_apig.Operation(
  scope: Construct,
  id: str,
  http_api_id: typing.Union[str, IResolvable],
  method: typing.Union[str, IResolvable],
  operation_name: typing.Union[str, IResolvable],
  path: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  mock: typing.Union[IResolvable, MockProperty] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

http_api_id^Required

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

Property httpApiId: The HTTP API ID to which the interface belongs.

method^Required

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

Property method: The method of http protocol.

operation_name^Required

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

Property operationName: The name of the operation.

path^Required

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

Property path: The interface path of the operation.

description^Optional

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

Property description: The description of the operation.

mock^Optional

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

Property mock: Mock configuration.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_apig
ros_cdk_apig.Operation.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

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

Attribute CreateTime: The creation timestamp of the operation.

attr_description^Required

attr_description: typing.Union[str, IResolvable]

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

Attribute Description: The description of the operation.

attr_method^Required

attr_method: typing.Union[str, IResolvable]

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

Attribute Method: The method of http protocol.

attr_mock^Required

attr_mock: typing.Union[str, IResolvable]

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

Attribute Mock: Mock configuration.

attr_operation_id^Required

attr_operation_id: typing.Union[str, IResolvable]

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

Attribute OperationId: The ID of the operation.

attr_operation_name^Required

attr_operation_name: typing.Union[str, IResolvable]

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

Attribute OperationName: The name of the resource.

attr_path^Required

attr_path: typing.Union[str, IResolvable]

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

Attribute Path: The interface path of the operation.

props^Required

props: OperationProps

• Type: OperationProps