class CfnRotation (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.SSMContacts.CfnRotation`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsssmcontacts#CfnRotation`
Java	`software.amazon.awscdk.services.ssmcontacts.CfnRotation`
Python	`aws_cdk.aws_ssmcontacts.CfnRotation`
TypeScript	`aws-cdk-lib` » `aws_ssmcontacts` » `CfnRotation`

Implements IConstruct, IDependable, IInspectable, ITaggable

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 .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ssmcontacts as ssmcontacts } from 'aws-cdk-lib';
const cfnRotation = new ssmcontacts.CfnRotation(this, 'MyCfnRotation', {
  contactIds: ['contactIds'],
  name: 'name',
  recurrence: {
    numberOfOnCalls: 123,
    recurrenceMultiplier: 123,

    // the properties below are optional
    dailySettings: ['dailySettings'],
    monthlySettings: [{
      dayOfMonth: 123,
      handOffTime: 'handOffTime',
    }],
    shiftCoverages: [{
      coverageTimes: [{
        endTime: 'endTime',
        startTime: 'startTime',
      }],
      dayOfWeek: 'dayOfWeek',
    }],
    weeklySettings: [{
      dayOfWeek: 'dayOfWeek',
      handOffTime: 'handOffTime',
    }],
  },
  startTime: 'startTime',
  timeZoneId: 'timeZoneId',

  // the properties below are optional
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnRotation(scope: Construct, id: string, props: CfnRotationProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnRotationProps — Resource properties.

Construct Props

Name	Type	Description
contactIds	`string[]`	The Amazon Resource Names (ARNs) of the contacts to add to the rotation.
name	`string`	The name for the rotation.
recurrence	`IResolvable` `\|` `RecurrenceSettingsProperty`	Information about the rule that specifies when shift team members rotate.
startTime	`string`	The date and time the rotation goes into effect.
timeZoneId	`string`	The time zone to base the rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format.
tags?	`CfnTag[]`	Optional metadata to assign to the rotation.

contactIds

Type: string[]

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

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

Type: string

The name for the rotation.

recurrence

Type: IResolvable | RecurrenceSettingsProperty

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

startTime

Type: string

The date and time the rotation goes into effect.

timeZoneId

Type: string

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.

Designators for time zones that don’t support Daylight Savings Time rules, such as Pacific Standard Time (PST), are not supported.

tags?

Type: CfnTag[] (optional)

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 .

Properties

Name	Type	Description
attrArn	`string`	The Amazon Resource Name (ARN) of the `Rotation` resource.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
contactIds	`string[]`	The Amazon Resource Names (ARNs) of the contacts to add to the rotation.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
name	`string`	The name for the rotation.
node	`Node`	The tree node.
recurrence	`IResolvable` `\|` `RecurrenceSettingsProperty`	Information about the rule that specifies when shift team members rotate.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
startTime	`string`	The date and time the rotation goes into effect.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
timeZoneId	`string`	The time zone to base the rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format.
tagsRaw?	`CfnTag[]`	Optional metadata to assign to the rotation.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrArn

Type: string

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

cfnOptions

Type: ICfnResourceOptions

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

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

contactIds

Type: string[]

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

creationStack

Type: string[]

logicalId

Type: string

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

name

Type: string

The name for the rotation.

node

Type: Node

The tree node.

recurrence

Type: IResolvable | RecurrenceSettingsProperty

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

ref

Type: string

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

Type: Stack

The stack in which this element is defined.

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

startTime

Type: string

The date and time the rotation goes into effect.

timeZoneId

Type: string

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

tagsRaw?

Type: CfnTag[] (optional)

Optional metadata to assign to the rotation.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

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.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

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

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

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.](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.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The 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,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

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

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

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

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

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

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

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:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

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.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

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)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

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

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

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

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

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

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

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.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }