Skip to content

AlarmContact

This class encapsulates and extends the ROS resource type DATASOURCE::CMS::AlarmContact.

Initializers 

from ros_cdk_cms import datasource
datasource.AlarmContact(
  scope: Construct,
  id: str,
  alarm_contact_name: typing.Union[str, IResolvable],
  refresh_options: 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.
alarm_contact_name typing.Union[str, ros_cdk_core.IResolvable] Property alarmContactName: AlarmContactName.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

alarm_contact_nameRequired

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

Property alarmContactName: AlarmContactName.

refresh_optionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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 

from ros_cdk_cms import datasource
datasource.AlarmContact.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_alarm_contact_name ros_cdk_core.IResolvable Attribute AlarmContactName: AlarmContactName.
attr_channels_ali_im ros_cdk_core.IResolvable Attribute ChannelsAliIm: ChannelsAliIM.
attr_channels_ding_web_hook ros_cdk_core.IResolvable Attribute ChannelsDingWebHook: ChannelsDingWebHook.
attr_channels_mail ros_cdk_core.IResolvable Attribute ChannelsMail: ChannelsMail.
attr_channels_sms ros_cdk_core.IResolvable Attribute ChannelsSms: ChannelsSMS.
attr_channels_state_ali_im ros_cdk_core.IResolvable Attribute ChannelsStateAliIm: ChannelsStateAliIM.
attr_channels_state_ding_web_hook ros_cdk_core.IResolvable Attribute ChannelsStateDingWebHook: ChannelsStateDingWebHook.
attr_channels_state_mail ros_cdk_core.IResolvable Attribute ChannelsStateMail: ChannelsStateMail.
attr_channels_state_sms ros_cdk_core.IResolvable Attribute ChannelsStateSms: ChannelsStateSMS.
attr_contact_groups ros_cdk_core.IResolvable Attribute ContactGroups: ContactGroups.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: CreateTime.
attr_describe ros_cdk_core.IResolvable Attribute Describe: Describe.
attr_lang ros_cdk_core.IResolvable Attribute Lang: The language type of the alarm.
attr_update_time ros_cdk_core.IResolvable Attribute UpdateTime: UpdateTime.

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_alarm_contact_nameRequired 

attr_alarm_contact_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AlarmContactName: AlarmContactName.

attr_channels_ali_imRequired 

attr_channels_ali_im: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ChannelsAliIm: ChannelsAliIM.

attr_channels_ding_web_hookRequired 

attr_channels_ding_web_hook: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ChannelsDingWebHook: ChannelsDingWebHook.

attr_channels_mailRequired 

attr_channels_mail: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ChannelsMail: ChannelsMail.

attr_channels_smsRequired 

attr_channels_sms: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ChannelsSms: ChannelsSMS.

attr_channels_state_ali_imRequired 

attr_channels_state_ali_im: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ChannelsStateAliIm: ChannelsStateAliIM.

attr_channels_state_ding_web_hookRequired 

attr_channels_state_ding_web_hook: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ChannelsStateDingWebHook: ChannelsStateDingWebHook.

attr_channels_state_mailRequired 

attr_channels_state_mail: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ChannelsStateMail: ChannelsStateMail.

attr_channels_state_smsRequired 

attr_channels_state_sms: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ChannelsStateSms: ChannelsStateSMS.

attr_contact_groupsRequired 

attr_contact_groups: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ContactGroups: ContactGroups.

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: CreateTime.

attr_describeRequired 

attr_describe: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Describe: Describe.

attr_langRequired 

attr_lang: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Lang: The language type of the alarm.

attr_update_timeRequired 

attr_update_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UpdateTime: UpdateTime.