CfnRotation

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

Bases: CfnResource

Specifies a rotation in an on-call schedule.

See:

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

CloudformationResource:

AWS::SSMContacts::Rotation

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 import aws_ssmcontacts as ssmcontacts

cfn_rotation = ssmcontacts.CfnRotation(self, "MyCfnRotation",
    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"
    )]
)
Parameters:
  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • contact_ids (Sequence[str]) – The Amazon Resource Names (ARNs) of the contacts to add to the rotation. .. epigraph:: Only the PERSONAL contact type is supported. The contact types ESCALATION and ONCALL_SCHEDULE are not supported for this operation. 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. .. epigraph:: Designators for time zones that don’t support Daylight Savings Time rules, such as Pacific Standard Time (PST), are not supported.

  • 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 .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:
  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:
  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::SSMContacts::Rotation'
attr_arn

The Amazon Resource Name (ARN) of the Rotation resource.

CloudformationAttribute:

Arn

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

contact_ids

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

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name for the rotation.

node

The tree node.

recurrence

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

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

start_time

The date and time the rotation goes into effect.

tags

Tag Manager which manages the tags for this resource.

tags_raw

Optional metadata to assign to the rotation.

time_zone_id

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

CoverageTimeProperty

class CfnRotation.CoverageTimeProperty(*, end_time, start_time)

Bases: object

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

Parameters:
  • end_time (str) – Information about when an on-call rotation shift ends.

  • start_time (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 import aws_ssmcontacts as ssmcontacts

coverage_time_property = ssmcontacts.CfnRotation.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 CfnRotation.MonthlySettingProperty(*, day_of_month, hand_off_time)

Bases: object

Information about on-call rotations that recur monthly.

Parameters:
  • day_of_month (Union[int, float]) – The day of the month when monthly recurring on-call rotations begin.

  • hand_off_time (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 import aws_ssmcontacts as ssmcontacts

monthly_setting_property = ssmcontacts.CfnRotation.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 CfnRotation.RecurrenceSettingsProperty(*, number_of_on_calls, recurrence_multiplier, daily_settings=None, monthly_settings=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:
  • number_of_on_calls (Union[int, float]) – 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]) – The number of days, weeks, or months a single rotation lasts.

  • 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.

  • 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 import aws_ssmcontacts as ssmcontacts

recurrence_settings_property = 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"
    )]
)

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 CfnRotation.ShiftCoverageProperty(*, coverage_times, day_of_week)

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]]]]) – The start and end times of the shift.

  • day_of_week (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 import aws_ssmcontacts as ssmcontacts

shift_coverage_property = ssmcontacts.CfnRotation.ShiftCoverageProperty(
    coverage_times=[ssmcontacts.CfnRotation.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 CfnRotation.WeeklySettingProperty(*, day_of_week, hand_off_time)

Bases: object

Information about rotations that recur weekly.

Parameters:
  • day_of_week (str) – The day of the week when weekly recurring on-call shift rotations begins.

  • hand_off_time (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 import aws_ssmcontacts as ssmcontacts

weekly_setting_property = ssmcontacts.CfnRotation.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