Trigger
- Implements: ITrigger
This class encapsulates and extends the ROS resource type ALIYUN::FC::Trigger.
Initializers
import ros_cdk_fc
ros_cdk_fc.Trigger(
scope: Construct,
id: str,
function_name: typing.Union[str, IResolvable],
service_name: typing.Union[str, IResolvable],
trigger_config: typing.Union[IResolvable, typing.Mapping[typing.Any]],
trigger_name: typing.Union[str, IResolvable],
trigger_type: typing.Union[str, IResolvable],
invocation_role: typing.Union[str, IResolvable] = None,
qualifier: typing.Union[str, IResolvable] = None,
source_arn: typing.Union[str, IResolvable] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
function_name | typing.Union[str, ros_cdk_core.IResolvable] | Property functionName: Function name. |
service_name | typing.Union[str, ros_cdk_core.IResolvable] | Property serviceName: Service name. |
trigger_config | typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] | Property triggerConfig: Event source specific trigger configuration. |
trigger_name | typing.Union[str, ros_cdk_core.IResolvable] | Property triggerName: Trigger name. |
trigger_type | typing.Union[str, ros_cdk_core.IResolvable] | Property triggerType: Trigger type, e.g. oss, timer, logs. This determines how the trigger config is interpreted. Example : "oss". |
invocation_role | typing.Union[str, ros_cdk_core.IResolvable] | Property invocationRole: The role grants event source the permission to run function on behalf of user. |
qualifier | typing.Union[str, ros_cdk_core.IResolvable] | Property qualifier: service version or alias. |
source_arn | typing.Union[str, ros_cdk_core.IResolvable] | Property sourceArn: The Aliyun Resource Name (ARN) of event source. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
function_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property functionName: Function name.
service_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property serviceName: Service name.
trigger_configRequired
- Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]
Property triggerConfig: Event source specific trigger configuration.
The value is different according to trigger type.
trigger_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property triggerName: Trigger name.
Example : "image_resize"
trigger_typeRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property triggerType: Trigger type, e.g. oss, timer, logs. This determines how the trigger config is interpreted. Example : "oss".
invocation_roleOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property invocationRole: The role grants event source the permission to run function on behalf of user.
This is optional for some triggers. Example : "acs:ram::1234567890:role/fc-test"
qualifierOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property qualifier: service version or alias.
Example : "LATEST"
source_arnOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property sourceArn: The Aliyun Resource Name (ARN) of event source.
This is optional for some triggers. Example : "acs:oss:cn-shanghai:12345:mybucket"
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. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | 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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- 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
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct | Return whether the given object is a Construct. |
is_construct
import ros_cdk_fc
ros_cdk_fc.Trigger.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
| Name | Type | Description |
|---|---|---|
node | ros_cdk_core.ConstructNode | The construct tree node associated with this construct. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
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_function_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute FunctionName: Function name. |
attr_service_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ServiceName: Service name. |
attr_trigger_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute TriggerId: The trigger ID. |
attr_trigger_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute TriggerName: Trigger name. |
attr_url_internet | typing.Union[str, ros_cdk_core.IResolvable] | Attribute UrlInternet: The public domain address. |
attr_url_intranet | typing.Union[str, ros_cdk_core.IResolvable] | Attribute UrlIntranet: The private endpoint. |
props | TriggerProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
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_function_nameRequired
attr_function_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute FunctionName: Function name.
attr_service_nameRequired
attr_service_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ServiceName: Service name.
attr_trigger_idRequired
attr_trigger_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute TriggerId: The trigger ID.
attr_trigger_nameRequired
attr_trigger_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute TriggerName: Trigger name.
attr_url_internetRequired
attr_url_internet: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute UrlInternet: The public domain address.
You can access HTTP triggers over the Internet by using HTTP or HTTPS.
attr_url_intranetRequired
attr_url_intranet: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute UrlIntranet: The private endpoint.
In a VPC, you can access HTTP triggers by using HTTP or HTTPS.
propsRequired
props: TriggerProps
- Type: TriggerProps