CfnRotationPropsMixin

class aws_cdk.mixins_preview.aws_ssmcontacts.mixins.CfnRotationPropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies a rotation in an on-call schedule.

Template example : We recommend creating all Incident Manager Contacts resources using a single AWS CloudFormation template. For a demonstration, see the examples for AWS::SSMContacts::Contacts .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html
CloudformationResource:: AWS::SSMContacts::Rotation
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_rotation_props_mixin = ssmcontacts_mixins.CfnRotationPropsMixin(ssmcontacts_mixins.CfnRotationMixinProps(
    contact_ids=["contactIds"],
    name="name",
    recurrence=ssmcontacts_mixins.CfnRotationPropsMixin.RecurrenceSettingsProperty(
        daily_settings=["dailySettings"],
        monthly_settings=[ssmcontacts_mixins.CfnRotationPropsMixin.MonthlySettingProperty(
            day_of_month=123,
            hand_off_time="handOffTime"
        )],
        number_of_on_calls=123,
        recurrence_multiplier=123,
        shift_coverages=[ssmcontacts_mixins.CfnRotationPropsMixin.ShiftCoverageProperty(
            coverage_times=[ssmcontacts_mixins.CfnRotationPropsMixin.CoverageTimeProperty(
                end_time="endTime",
                start_time="startTime"
            )],
            day_of_week="dayOfWeek"
        )],
        weekly_settings=[ssmcontacts_mixins.CfnRotationPropsMixin.WeeklySettingProperty(
            day_of_week="dayOfWeek",
            hand_off_time="handOffTime"
        )]
    ),
    start_time="startTime",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    time_zone_id="timeZoneId"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SSMContacts::Rotation.

Parameters:

props (Union[CfnRotationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['contactIds', 'name', 'recurrence', 'startTime', 'tags', 'timeZoneId']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CoverageTimeProperty

class CfnRotationPropsMixin.CoverageTimeProperty(*, end_time=None, start_time=None)

Bases: object

Information about when an on-call shift begins and ends.

Parameters:

end_time (Optional[str]) – Information about when an on-call rotation shift ends.
start_time (Optional[str]) – Information about when an on-call rotation shift begins.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

coverage_time_property = ssmcontacts_mixins.CfnRotationPropsMixin.CoverageTimeProperty(
    end_time="endTime",
    start_time="startTime"
)

Attributes

end_time

Information about when an on-call rotation shift ends.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-coveragetime.html#cfn-ssmcontacts-rotation-coveragetime-endtime

start_time

Information about when an on-call rotation shift begins.

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

MonthlySettingProperty

class CfnRotationPropsMixin.MonthlySettingProperty(*, day_of_month=None, hand_off_time=None)

Bases: object

Information about on-call rotations that recur monthly.

Parameters:

day_of_month (Union[int, float, None]) – The day of the month when monthly recurring on-call rotations begin.
hand_off_time (Optional[str]) – The time of day when a monthly recurring on-call shift rotation begins.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

monthly_setting_property = ssmcontacts_mixins.CfnRotationPropsMixin.MonthlySettingProperty(
    day_of_month=123,
    hand_off_time="handOffTime"
)

Attributes

day_of_month

The day of the month when monthly recurring on-call rotations begin.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-monthlysetting.html#cfn-ssmcontacts-rotation-monthlysetting-dayofmonth

hand_off_time

The time of day when a monthly recurring on-call shift rotation begins.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-monthlysetting.html#cfn-ssmcontacts-rotation-monthlysetting-handofftime

RecurrenceSettingsProperty

class CfnRotationPropsMixin.RecurrenceSettingsProperty(*, daily_settings=None, monthly_settings=None, number_of_on_calls=None, recurrence_multiplier=None, shift_coverages=None, weekly_settings=None)

Bases: object

Information about when an on-call rotation is in effect and how long the rotation period lasts.

Parameters:

daily_settings (Optional[Sequence[str]]) – Information about on-call rotations that recur daily.
monthly_settings (Union[IResolvable, Sequence[Union[IResolvable, MonthlySettingProperty, Dict[str, Any]]], None]) – Information about on-call rotations that recur monthly.
number_of_on_calls (Union[int, float, None]) – The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule that contains ten contacts, a value of 2 designates that two of them are on call at any given time.
recurrence_multiplier (Union[int, float, None]) – The number of days, weeks, or months a single rotation lasts.
shift_coverages (Union[IResolvable, Sequence[Union[IResolvable, ShiftCoverageProperty, Dict[str, Any]]], None]) – Information about the days of the week included in on-call rotation coverage.
weekly_settings (Union[IResolvable, Sequence[Union[IResolvable, WeeklySettingProperty, Dict[str, Any]]], None]) – Information about on-call rotations that recur weekly.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

recurrence_settings_property = ssmcontacts_mixins.CfnRotationPropsMixin.RecurrenceSettingsProperty(
    daily_settings=["dailySettings"],
    monthly_settings=[ssmcontacts_mixins.CfnRotationPropsMixin.MonthlySettingProperty(
        day_of_month=123,
        hand_off_time="handOffTime"
    )],
    number_of_on_calls=123,
    recurrence_multiplier=123,
    shift_coverages=[ssmcontacts_mixins.CfnRotationPropsMixin.ShiftCoverageProperty(
        coverage_times=[ssmcontacts_mixins.CfnRotationPropsMixin.CoverageTimeProperty(
            end_time="endTime",
            start_time="startTime"
        )],
        day_of_week="dayOfWeek"
    )],
    weekly_settings=[ssmcontacts_mixins.CfnRotationPropsMixin.WeeklySettingProperty(
        day_of_week="dayOfWeek",
        hand_off_time="handOffTime"
    )]
)

Attributes

daily_settings

Information about on-call rotations that recur daily.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-dailysettings

monthly_settings

Information about on-call rotations that recur monthly.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-monthlysettings

number_of_on_calls

The number of contacts, or shift team members designated to be on call concurrently during a shift.

For example, in an on-call schedule that contains ten contacts, a value of 2 designates that two of them are on call at any given time.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-numberofoncalls

recurrence_multiplier

The number of days, weeks, or months a single rotation lasts.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-recurrencemultiplier

shift_coverages

Information about the days of the week included in on-call rotation coverage.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-shiftcoverages

weekly_settings

Information about on-call rotations that recur weekly.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-weeklysettings

ShiftCoverageProperty

class CfnRotationPropsMixin.ShiftCoverageProperty(*, coverage_times=None, day_of_week=None)

Bases: object

Information about the days of the week that the on-call rotation coverage includes.

Parameters:

coverage_times (Union[IResolvable, Sequence[Union[IResolvable, CoverageTimeProperty, Dict[str, Any]]], None]) – The start and end times of the shift.
day_of_week (Optional[str]) – A list of days on which the schedule is active.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

shift_coverage_property = ssmcontacts_mixins.CfnRotationPropsMixin.ShiftCoverageProperty(
    coverage_times=[ssmcontacts_mixins.CfnRotationPropsMixin.CoverageTimeProperty(
        end_time="endTime",
        start_time="startTime"
    )],
    day_of_week="dayOfWeek"
)

Attributes

coverage_times

The start and end times of the shift.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-shiftcoverage.html#cfn-ssmcontacts-rotation-shiftcoverage-coveragetimes

day_of_week

A list of days on which the schedule is active.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-shiftcoverage.html#cfn-ssmcontacts-rotation-shiftcoverage-dayofweek

WeeklySettingProperty

class CfnRotationPropsMixin.WeeklySettingProperty(*, day_of_week=None, hand_off_time=None)

Bases: object

Information about rotations that recur weekly.

Parameters:

day_of_week (Optional[str]) – The day of the week when weekly recurring on-call shift rotations begins.
hand_off_time (Optional[str]) – The time of day when a weekly recurring on-call shift rotation begins.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

weekly_setting_property = ssmcontacts_mixins.CfnRotationPropsMixin.WeeklySettingProperty(
    day_of_week="dayOfWeek",
    hand_off_time="handOffTime"
)

Attributes

day_of_week

The day of the week when weekly recurring on-call shift rotations begins.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-weeklysetting.html#cfn-ssmcontacts-rotation-weeklysetting-dayofweek

hand_off_time

The time of day when a weekly recurring on-call shift rotation begins.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-weeklysetting.html#cfn-ssmcontacts-rotation-weeklysetting-handofftime