DeliveryChannel
- Implements: IDeliveryChannel
This class encapsulates and extends the ROS resource type ALIYUN::ResourceManager::DeliveryChannel.
Initializers
import ros_cdk_resourcemanager
ros_cdk_resourcemanager.DeliveryChannel(
scope: Construct,
id: str,
delivery_channel_filter: typing.Union[IResolvable, DeliveryChannelFilterProperty],
delivery_channel_name: typing.Union[str, IResolvable],
delivery_channel_description: typing.Union[str, IResolvable] = None,
delivery_channel_id: typing.Union[str, IResolvable] = None,
enabled_resource_change_delivery: typing.Union[str, IResolvable] = None,
enabled_resource_snapshot_delivery: typing.Union[str, IResolvable] = None,
resource_change_delivery: typing.Union[IResolvable, ResourceChangeDeliveryProperty] = None,
resource_snapshot_delivery: typing.Union[IResolvable, ResourceSnapshotDeliveryProperty] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
delivery_channel_filter | typing.Union[ros_cdk_core.IResolvable, DeliveryChannelFilterProperty] | Property deliveryChannelFilter: The effective scope of the delivery channel. |
delivery_channel_name | typing.Union[str, ros_cdk_core.IResolvable] | Property deliveryChannelName: The name of the delivery channel. |
delivery_channel_description | typing.Union[str, ros_cdk_core.IResolvable] | Property deliveryChannelDescription: The description of the delivery channel. |
delivery_channel_id | typing.Union[str, ros_cdk_core.IResolvable] | Property deliveryChannelId: The ID of the delivery channel. |
enabled_resource_change_delivery | typing.Union[str, ros_cdk_core.IResolvable] | Property enabledResourceChangeDelivery: Enable resource change delivery. |
enabled_resource_snapshot_delivery | typing.Union[str, ros_cdk_core.IResolvable] | Property enabledResourceSnapshotDelivery: Enable resource snapshot delivery. |
resource_change_delivery | typing.Union[ros_cdk_core.IResolvable, ResourceChangeDeliveryProperty] | Property resourceChangeDelivery: The delivery of resource configuration changes. |
resource_snapshot_delivery | typing.Union[ros_cdk_core.IResolvable, ResourceSnapshotDeliveryProperty] | Property resourceSnapshotDelivery: The scheduled delivery of resource snapshots. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
delivery_channel_filterRequired
- Type: typing.Union[ros_cdk_core.IResolvable, DeliveryChannelFilterProperty]
Property deliveryChannelFilter: The effective scope of the delivery channel.
delivery_channel_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property deliveryChannelName: The name of the delivery channel.
delivery_channel_descriptionOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property deliveryChannelDescription: The description of the delivery channel.
delivery_channel_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property deliveryChannelId: The ID of the delivery channel.
enabled_resource_change_deliveryOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property enabledResourceChangeDelivery: Enable resource change delivery.
enabled_resource_snapshot_deliveryOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property enabledResourceSnapshotDelivery: Enable resource snapshot delivery.
resource_change_deliveryOptional
- Type: typing.Union[ros_cdk_core.IResolvable, ResourceChangeDeliveryProperty]
Property resourceChangeDelivery: The delivery of resource configuration changes.
resource_snapshot_deliveryOptional
- Type: typing.Union[ros_cdk_core.IResolvable, ResourceSnapshotDeliveryProperty]
Property resourceSnapshotDelivery: The scheduled delivery of resource snapshots.
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_resourcemanager
ros_cdk_resourcemanager.DeliveryChannel.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_delivery_channel_description | typing.Union[str, ros_cdk_core.IResolvable] | Attribute DeliveryChannelDescription: The description of the delivery channel. |
attr_delivery_channel_filter | typing.Union[str, ros_cdk_core.IResolvable] | Attribute DeliveryChannelFilter: The effective scope of the delivery channel. |
attr_delivery_channel_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute DeliveryChannelId: The ID of the delivery channel. |
attr_delivery_channel_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute DeliveryChannelName: The name of the delivery channel. |
attr_resource_change_delivery | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ResourceChangeDelivery: The delivery of resource configuration changes. |
attr_resource_snapshot_delivery | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ResourceSnapshotDelivery: The scheduled delivery of resource snapshots. |
props | DeliveryChannelProps | 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_delivery_channel_descriptionRequired
attr_delivery_channel_description: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute DeliveryChannelDescription: The description of the delivery channel.
attr_delivery_channel_filterRequired
attr_delivery_channel_filter: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute DeliveryChannelFilter: The effective scope of the delivery channel.
attr_delivery_channel_idRequired
attr_delivery_channel_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute DeliveryChannelId: The ID of the delivery channel.
attr_delivery_channel_nameRequired
attr_delivery_channel_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute DeliveryChannelName: The name of the delivery channel.
attr_resource_change_deliveryRequired
attr_resource_change_delivery: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ResourceChangeDelivery: The delivery of resource configuration changes.
attr_resource_snapshot_deliveryRequired
attr_resource_snapshot_delivery: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ResourceSnapshotDelivery: The scheduled delivery of resource snapshots.
propsRequired
props: DeliveryChannelProps
- Type: DeliveryChannelProps