1. Packages
  2. AWS Native
  3. API Docs
  4. ssmcontacts
  5. getRotation

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

aws-native.ssmcontacts.getRotation

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

    Resource Type definition for AWS::SSMContacts::Rotation.

    Using getRotation

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRotation(args: GetRotationArgs, opts?: InvokeOptions): Promise<GetRotationResult>
    function getRotationOutput(args: GetRotationOutputArgs, opts?: InvokeOptions): Output<GetRotationResult>
    def get_rotation(arn: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetRotationResult
    def get_rotation_output(arn: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetRotationResult]
    func LookupRotation(ctx *Context, args *LookupRotationArgs, opts ...InvokeOption) (*LookupRotationResult, error)
    func LookupRotationOutput(ctx *Context, args *LookupRotationOutputArgs, opts ...InvokeOption) LookupRotationResultOutput

    > Note: This function is named LookupRotation in the Go SDK.

    public static class GetRotation 
    {
        public static Task<GetRotationResult> InvokeAsync(GetRotationArgs args, InvokeOptions? opts = null)
        public static Output<GetRotationResult> Invoke(GetRotationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRotationResult> getRotation(GetRotationArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:ssmcontacts:getRotation
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the rotation.
    Arn string
    The Amazon Resource Name (ARN) of the rotation.
    arn String
    The Amazon Resource Name (ARN) of the rotation.
    arn string
    The Amazon Resource Name (ARN) of the rotation.
    arn str
    The Amazon Resource Name (ARN) of the rotation.
    arn String
    The Amazon Resource Name (ARN) of the rotation.

    getRotation Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the rotation.
    ContactIds List<string>
    Members of the rotation
    Name string
    Name of the Rotation
    Recurrence Pulumi.AwsNative.SsmContacts.Outputs.RotationRecurrenceSettings
    Information about the rule that specifies when shift team members rotate.
    StartTime string
    Start time of the first shift of Oncall Schedule
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    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 .
    TimeZoneId string
    TimeZone Identifier for the Oncall Schedule
    Arn string
    The Amazon Resource Name (ARN) of the rotation.
    ContactIds []string
    Members of the rotation
    Name string
    Name of the Rotation
    Recurrence RotationRecurrenceSettings
    Information about the rule that specifies when shift team members rotate.
    StartTime string
    Start time of the first shift of Oncall Schedule
    Tags Tag
    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 .
    TimeZoneId string
    TimeZone Identifier for the Oncall Schedule
    arn String
    The Amazon Resource Name (ARN) of the rotation.
    contactIds List<String>
    Members of the rotation
    name String
    Name of the Rotation
    recurrence RotationRecurrenceSettings
    Information about the rule that specifies when shift team members rotate.
    startTime String
    Start time of the first shift of Oncall Schedule
    tags List<Tag>
    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 .
    timeZoneId String
    TimeZone Identifier for the Oncall Schedule
    arn string
    The Amazon Resource Name (ARN) of the rotation.
    contactIds string[]
    Members of the rotation
    name string
    Name of the Rotation
    recurrence RotationRecurrenceSettings
    Information about the rule that specifies when shift team members rotate.
    startTime string
    Start time of the first shift of Oncall Schedule
    tags Tag[]
    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 .
    timeZoneId string
    TimeZone Identifier for the Oncall Schedule
    arn str
    The Amazon Resource Name (ARN) of the rotation.
    contact_ids Sequence[str]
    Members of the rotation
    name str
    Name of the Rotation
    recurrence RotationRecurrenceSettings
    Information about the rule that specifies when shift team members rotate.
    start_time str
    Start time of the first shift of Oncall Schedule
    tags Sequence[root_Tag]
    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 .
    time_zone_id str
    TimeZone Identifier for the Oncall Schedule
    arn String
    The Amazon Resource Name (ARN) of the rotation.
    contactIds List<String>
    Members of the rotation
    name String
    Name of the Rotation
    recurrence Property Map
    Information about the rule that specifies when shift team members rotate.
    startTime String
    Start time of the first shift of Oncall Schedule
    tags List<Property Map>
    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 .
    timeZoneId String
    TimeZone Identifier for the Oncall Schedule

    Supporting Types

    RotationCoverageTime

    EndTime string
    Information about when an on-call rotation shift ends.
    StartTime string
    Information about when an on-call rotation shift begins.
    EndTime string
    Information about when an on-call rotation shift ends.
    StartTime string
    Information about when an on-call rotation shift begins.
    endTime String
    Information about when an on-call rotation shift ends.
    startTime String
    Information about when an on-call rotation shift begins.
    endTime string
    Information about when an on-call rotation shift ends.
    startTime string
    Information about when an on-call rotation shift begins.
    end_time str
    Information about when an on-call rotation shift ends.
    start_time str
    Information about when an on-call rotation shift begins.
    endTime String
    Information about when an on-call rotation shift ends.
    startTime String
    Information about when an on-call rotation shift begins.

    RotationDayOfWeek

    RotationMonthlySetting

    DayOfMonth int
    The day of the month when monthly recurring on-call rotations begin.
    HandOffTime string
    The time of day when a monthly recurring on-call shift rotation begins.
    DayOfMonth int
    The day of the month when monthly recurring on-call rotations begin.
    HandOffTime string
    The time of day when a monthly recurring on-call shift rotation begins.
    dayOfMonth Integer
    The day of the month when monthly recurring on-call rotations begin.
    handOffTime String
    The time of day when a monthly recurring on-call shift rotation begins.
    dayOfMonth number
    The day of the month when monthly recurring on-call rotations begin.
    handOffTime string
    The time of day when a monthly recurring on-call shift rotation begins.
    day_of_month int
    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.
    dayOfMonth Number
    The day of the month when monthly recurring on-call rotations begin.
    handOffTime String
    The time of day when a monthly recurring on-call shift rotation begins.

    RotationRecurrenceSettings

    DailySettings List<string>
    Information about on-call rotations that recur daily.
    MonthlySettings List<Pulumi.AwsNative.SsmContacts.Inputs.RotationMonthlySetting>
    Information about on-call rotations that recur monthly.
    NumberOfOnCalls int
    Number of Oncalls per shift.
    RecurrenceMultiplier int
    The number of days, weeks, or months a single rotation lasts.
    ShiftCoverages List<Pulumi.AwsNative.SsmContacts.Inputs.RotationShiftCoverage>
    Information about the days of the week included in on-call rotation coverage.
    WeeklySettings List<Pulumi.AwsNative.SsmContacts.Inputs.RotationWeeklySetting>
    Information about on-call rotations that recur weekly.
    DailySettings []string
    Information about on-call rotations that recur daily.
    MonthlySettings []RotationMonthlySetting
    Information about on-call rotations that recur monthly.
    NumberOfOnCalls int
    Number of Oncalls per shift.
    RecurrenceMultiplier int
    The number of days, weeks, or months a single rotation lasts.
    ShiftCoverages []RotationShiftCoverage
    Information about the days of the week included in on-call rotation coverage.
    WeeklySettings []RotationWeeklySetting
    Information about on-call rotations that recur weekly.
    dailySettings List<String>
    Information about on-call rotations that recur daily.
    monthlySettings List<RotationMonthlySetting>
    Information about on-call rotations that recur monthly.
    numberOfOnCalls Integer
    Number of Oncalls per shift.
    recurrenceMultiplier Integer
    The number of days, weeks, or months a single rotation lasts.
    shiftCoverages List<RotationShiftCoverage>
    Information about the days of the week included in on-call rotation coverage.
    weeklySettings List<RotationWeeklySetting>
    Information about on-call rotations that recur weekly.
    dailySettings string[]
    Information about on-call rotations that recur daily.
    monthlySettings RotationMonthlySetting[]
    Information about on-call rotations that recur monthly.
    numberOfOnCalls number
    Number of Oncalls per shift.
    recurrenceMultiplier number
    The number of days, weeks, or months a single rotation lasts.
    shiftCoverages RotationShiftCoverage[]
    Information about the days of the week included in on-call rotation coverage.
    weeklySettings RotationWeeklySetting[]
    Information about on-call rotations that recur weekly.
    daily_settings Sequence[str]
    Information about on-call rotations that recur daily.
    monthly_settings Sequence[RotationMonthlySetting]
    Information about on-call rotations that recur monthly.
    number_of_on_calls int
    Number of Oncalls per shift.
    recurrence_multiplier int
    The number of days, weeks, or months a single rotation lasts.
    shift_coverages Sequence[RotationShiftCoverage]
    Information about the days of the week included in on-call rotation coverage.
    weekly_settings Sequence[RotationWeeklySetting]
    Information about on-call rotations that recur weekly.
    dailySettings List<String>
    Information about on-call rotations that recur daily.
    monthlySettings List<Property Map>
    Information about on-call rotations that recur monthly.
    numberOfOnCalls Number
    Number of Oncalls per shift.
    recurrenceMultiplier Number
    The number of days, weeks, or months a single rotation lasts.
    shiftCoverages List<Property Map>
    Information about the days of the week included in on-call rotation coverage.
    weeklySettings List<Property Map>
    Information about on-call rotations that recur weekly.

    RotationShiftCoverage

    CoverageTimes List<Pulumi.AwsNative.SsmContacts.Inputs.RotationCoverageTime>
    Information about when an on-call shift begins and ends.
    DayOfWeek Pulumi.AwsNative.SsmContacts.RotationDayOfWeek
    A list of days on which the schedule is active.
    CoverageTimes []RotationCoverageTime
    Information about when an on-call shift begins and ends.
    DayOfWeek RotationDayOfWeek
    A list of days on which the schedule is active.
    coverageTimes List<RotationCoverageTime>
    Information about when an on-call shift begins and ends.
    dayOfWeek RotationDayOfWeek
    A list of days on which the schedule is active.
    coverageTimes RotationCoverageTime[]
    Information about when an on-call shift begins and ends.
    dayOfWeek RotationDayOfWeek
    A list of days on which the schedule is active.
    coverage_times Sequence[RotationCoverageTime]
    Information about when an on-call shift begins and ends.
    day_of_week RotationDayOfWeek
    A list of days on which the schedule is active.
    coverageTimes List<Property Map>
    Information about when an on-call shift begins and ends.
    dayOfWeek "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN"
    A list of days on which the schedule is active.

    RotationWeeklySetting

    DayOfWeek Pulumi.AwsNative.SsmContacts.RotationDayOfWeek
    The day of the week when weekly recurring on-call shift rotations begins.
    HandOffTime string
    The time of day when a weekly recurring on-call shift rotation begins.
    DayOfWeek RotationDayOfWeek
    The day of the week when weekly recurring on-call shift rotations begins.
    HandOffTime string
    The time of day when a weekly recurring on-call shift rotation begins.
    dayOfWeek RotationDayOfWeek
    The day of the week when weekly recurring on-call shift rotations begins.
    handOffTime String
    The time of day when a weekly recurring on-call shift rotation begins.
    dayOfWeek RotationDayOfWeek
    The day of the week when weekly recurring on-call shift rotations begins.
    handOffTime string
    The time of day when a weekly recurring on-call shift rotation begins.
    day_of_week RotationDayOfWeek
    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.
    dayOfWeek "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "SUN"
    The day of the week when weekly recurring on-call shift rotations begins.
    handOffTime String
    The time of day when a weekly recurring on-call shift rotation begins.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi