CfnRotationProps

class aws_cdk.aws_ssmcontacts.CfnRotationProps(*, contact_ids, name, recurrence, start_time, time_zone_id, tags=None)

Bases: object

Properties for defining a CfnRotation.

Parameters:

  • contact_ids (Sequence[str]) – The Amazon Resource Names (ARNs) of the contacts to add to the rotation. The order in which you list the contacts is their shift order in the rotation schedule.

  • name (str) – The name for the rotation.

  • recurrence (Union[IResolvable, RecurrenceSettingsProperty, Dict[str, Any]]) – Information about the rule that specifies when shift team members rotate.

  • start_time (str) – The date and time the rotation goes into effect.

  • time_zone_id (str) – The time zone to base the rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format. For example: “America/Los_Angeles”, “UTC”, or “Asia/Seoul”. For more information, see the Time Zone Database on the IANA website.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Optional metadata to assign to the rotation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For more information, see Tagging Incident Manager resources in the Incident Manager User Guide .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ssmcontacts as ssmcontacts

cfn_rotation_props = ssmcontacts.CfnRotationProps(
    contact_ids=["contactIds"],
    name="name",
    recurrence=ssmcontacts.CfnRotation.RecurrenceSettingsProperty(
        number_of_on_calls=123,
        recurrence_multiplier=123,

        # the properties below are optional
        daily_settings=["dailySettings"],
        monthly_settings=[ssmcontacts.CfnRotation.MonthlySettingProperty(
            day_of_month=123,
            hand_off_time="handOffTime"
        )],
        shift_coverages=[ssmcontacts.CfnRotation.ShiftCoverageProperty(
            coverage_times=[ssmcontacts.CfnRotation.CoverageTimeProperty(
                end_time="endTime",
                start_time="startTime"
            )],
            day_of_week="dayOfWeek"
        )],
        weekly_settings=[ssmcontacts.CfnRotation.WeeklySettingProperty(
            day_of_week="dayOfWeek",
            hand_off_time="handOffTime"
        )]
    ),
    start_time="startTime",
    time_zone_id="timeZoneId",

    # the properties below are optional
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

contact_ids

The Amazon Resource Names (ARNs) of the contacts to add to the rotation.

The order in which you list the contacts is their shift order in the rotation schedule.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-contactids

name

The name for the rotation.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-name

recurrence

Information about the rule that specifies when shift team members rotate.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-recurrence

start_time

The date and time the rotation goes into effect.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-starttime

tags

Optional metadata to assign to the rotation.

Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For more information, see Tagging Incident Manager resources in the Incident Manager User Guide .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-tags

time_zone_id

The time zone to base the rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format.

For example: “America/Los_Angeles”, “UTC”, or “Asia/Seoul”. For more information, see the Time Zone Database on the IANA website.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-timezoneid