Class ContactsRotation


  • public class ContactsRotation
    extends com.pulumi.resources.CustomResource
    Provides a Terraform resource for managing a Contacts Rotation in AWS Systems Manager Incident Manager. > **NOTE:** A rotation implicitly depends on a replication set. If you configured your replication set in Terraform, we recommend you add it to the `dependsOn` argument for the Terraform Contact Resource. ## Example Usage ### Basic Usage
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.ssm.ContactsRotation;
     import com.pulumi.aws.ssm.ContactsRotationArgs;
     import com.pulumi.aws.ssm.inputs.ContactsRotationRecurrenceArgs;
     import com.pulumi.aws.ssm.inputs.ContactsRotationRecurrenceDailySettingArgs;
     import com.pulumi.resources.CustomResourceOptions;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new ContactsRotation("example", ContactsRotationArgs.builder()
                 .recurrence(ContactsRotationRecurrenceArgs.builder()
                     .dailySettings(ContactsRotationRecurrenceDailySettingArgs.builder()
                         .hourOfDay(9)
                         .minuteOfHour(0)
                         .build())
                     .numberOfOnCalls(1)
                     .recurrenceMultiplier(1)
                     .build())
                 .contactIds(exampleAwsSsmcontactsContact.arn())
                 .name("rotation")
                 .timeZoneId("Australia/Sydney")
                 .build(), CustomResourceOptions.builder()
                     .dependsOn(exampleAwsSsmincidentsReplicationSet)
                     .build());
     
         }
     }
     
     
    ### Usage with Weekly Settings and Shift Coverages Fields
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.ssm.ContactsRotation;
     import com.pulumi.aws.ssm.ContactsRotationArgs;
     import com.pulumi.aws.ssm.inputs.ContactsRotationRecurrenceArgs;
     import com.pulumi.aws.ssm.inputs.ContactsRotationRecurrenceShiftCoverageArgs;
     import com.pulumi.aws.ssm.inputs.ContactsRotationRecurrenceShiftCoverageCoverageTimeArgs;
     import com.pulumi.aws.ssm.inputs.ContactsRotationRecurrenceShiftCoverageCoverageTimeStartArgs;
     import com.pulumi.aws.ssm.inputs.ContactsRotationRecurrenceShiftCoverageCoverageTimeEndArgs;
     import com.pulumi.aws.ssm.inputs.ContactsRotationRecurrenceWeeklySettingArgs;
     import com.pulumi.aws.ssm.inputs.ContactsRotationRecurrenceWeeklySettingHandOffTimeArgs;
     import com.pulumi.resources.CustomResourceOptions;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new ContactsRotation("example", ContactsRotationArgs.builder()
                 .recurrence(ContactsRotationRecurrenceArgs.builder()
                     .shiftCoverages(ContactsRotationRecurrenceShiftCoverageArgs.builder()
                         .coverageTimes(ContactsRotationRecurrenceShiftCoverageCoverageTimeArgs.builder()
                             .start(ContactsRotationRecurrenceShiftCoverageCoverageTimeStartArgs.builder()
                                 .hourOfDay(1)
                                 .minuteOfHour(0)
                                 .build())
                             .end(ContactsRotationRecurrenceShiftCoverageCoverageTimeEndArgs.builder()
                                 .hourOfDay(23)
                                 .minuteOfHour(0)
                                 .build())
                             .build())
                         .mapBlockKey("MON")
                         .build())
                     .weeklySettings(                
                         ContactsRotationRecurrenceWeeklySettingArgs.builder()
                             .handOffTime(ContactsRotationRecurrenceWeeklySettingHandOffTimeArgs.builder()
                                 .hourOfDay(4)
                                 .minuteOfHour(25)
                                 .build())
                             .dayOfWeek("WED")
                             .build(),
                         ContactsRotationRecurrenceWeeklySettingArgs.builder()
                             .handOffTime(ContactsRotationRecurrenceWeeklySettingHandOffTimeArgs.builder()
                                 .hourOfDay(15)
                                 .minuteOfHour(57)
                                 .build())
                             .dayOfWeek("FRI")
                             .build())
                     .numberOfOnCalls(1)
                     .recurrenceMultiplier(1)
                     .build())
                 .contactIds(exampleAwsSsmcontactsContact.arn())
                 .name("rotation")
                 .startTime("2023-07-20T02:21:49+00:00")
                 .timeZoneId("Australia/Sydney")
                 .tags(Map.ofEntries(
                     Map.entry("key1", "tag1"),
                     Map.entry("key2", "tag2")
                 ))
                 .build(), CustomResourceOptions.builder()
                     .dependsOn(exampleAwsSsmincidentsReplicationSet)
                     .build());
     
         }
     }
     
     
    ### Usage with Monthly Settings Fields
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.ssm.ContactsRotation;
     import com.pulumi.aws.ssm.ContactsRotationArgs;
     import com.pulumi.aws.ssm.inputs.ContactsRotationRecurrenceArgs;
     import com.pulumi.aws.ssm.inputs.ContactsRotationRecurrenceMonthlySettingArgs;
     import com.pulumi.aws.ssm.inputs.ContactsRotationRecurrenceMonthlySettingHandOffTimeArgs;
     import com.pulumi.resources.CustomResourceOptions;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new ContactsRotation("example", ContactsRotationArgs.builder()
                 .recurrence(ContactsRotationRecurrenceArgs.builder()
                     .monthlySettings(                
                         ContactsRotationRecurrenceMonthlySettingArgs.builder()
                             .handOffTime(ContactsRotationRecurrenceMonthlySettingHandOffTimeArgs.builder()
                                 .hourOfDay(8)
                                 .minuteOfHour(0)
                                 .build())
                             .dayOfMonth(20)
                             .build(),
                         ContactsRotationRecurrenceMonthlySettingArgs.builder()
                             .handOffTime(ContactsRotationRecurrenceMonthlySettingHandOffTimeArgs.builder()
                                 .hourOfDay(12)
                                 .minuteOfHour(34)
                                 .build())
                             .dayOfMonth(13)
                             .build())
                     .numberOfOnCalls(1)
                     .recurrenceMultiplier(1)
                     .build())
                 .contactIds(exampleAwsSsmcontactsContact.arn())
                 .name("rotation")
                 .timeZoneId("Australia/Sydney")
                 .build(), CustomResourceOptions.builder()
                     .dependsOn(exampleAwsSsmincidentsReplicationSet)
                     .build());
     
         }
     }
     
     
    ## Import ### Identity Schema #### Required - `arn` (String) ARN of the SSM Contacts rotation. Using `pulumi import`, import CodeGuru Profiler Profiling Group using the `arn`. For example: ```sh $ pulumi import aws:ssm/contactsRotation:ContactsRotation example arn:aws:ssm-contacts:us-east-1:012345678910:rotation/example ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> contactIds()  
      static ContactsRotation get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ContactsRotationState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<ContactsRotationRecurrence> recurrence()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> startTime()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> timeZoneId()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ContactsRotation

        public ContactsRotation​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • ContactsRotation

        public ContactsRotation​(java.lang.String name,
                                ContactsRotationArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • ContactsRotation

        public ContactsRotation​(java.lang.String name,
                                ContactsRotationArgs args,
                                @Nullable
                                com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the rotation.
      • contactIds

        public com.pulumi.core.Output<java.util.List<java.lang.String>> contactIds()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name for the rotation.
      • recurrence

        public com.pulumi.core.Output<ContactsRotationRecurrence> recurrence()
        Returns:
        Information about when an on-call rotation is in effect and how long the rotation period lasts. Exactly one of either `dailySettings`, `monthlySettings`, or `weeklySettings` must be populated. See Recurrence for more details. The following arguments are optional:
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • startTime

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> startTime()
        Returns:
        The date and time, in RFC 3339 format, that the rotation goes into effect.
      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
      • timeZoneId

        public com.pulumi.core.Output<java.lang.String> timeZoneId()
        Returns:
        The time zone to base the rotation’s activity on in Internet Assigned Numbers Authority (IANA) format.
      • get

        public static ContactsRotation get​(java.lang.String name,
                                           com.pulumi.core.Output<java.lang.String> id,
                                           @Nullable
                                           ContactsRotationState state,
                                           @Nullable
                                           com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.