Package software.amazon.awssdk.services.ssmcontacts.model

Interface CreateRotationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateRotationRequest.Builder,CreateRotationRequest>, SdkBuilder<CreateRotationRequest.Builder,CreateRotationRequest>, SdkPojo, SdkRequest.Builder, SsmContactsRequest.Builder
Enclosing class:
CreateRotationRequest
public static interface CreateRotationRequest.Builder extends SsmContactsRequest.Builder, SdkPojo, CopyableBuilder<CreateRotationRequest.Builder,CreateRotationRequest>

  • Method Details

    • name

      CreateRotationRequest.Builder name(String name)

      The name of the rotation.

      Parameters:
      name - The name of the rotation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contactIds

      CreateRotationRequest.Builder contactIds(Collection<String> contactIds)

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

      The order that you list the contacts in is their shift order in the rotation schedule. To change the order of the contact's shifts, use the UpdateRotation operation.

      Parameters:
      contactIds - The Amazon Resource Names (ARNs) of the contacts to add to the rotation.

      The order that you list the contacts in is their shift order in the rotation schedule. To change the order of the contact's shifts, use the UpdateRotation operation.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contactIds

      CreateRotationRequest.Builder contactIds(String... contactIds)

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

      The order that you list the contacts in is their shift order in the rotation schedule. To change the order of the contact's shifts, use the UpdateRotation operation.

      Parameters:
      contactIds - The Amazon Resource Names (ARNs) of the contacts to add to the rotation.

      The order that you list the contacts in is their shift order in the rotation schedule. To change the order of the contact's shifts, use the UpdateRotation operation.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      CreateRotationRequest.Builder startTime(Instant startTime)

      The date and time that the rotation goes into effect.

      Parameters:
      startTime - The date and time that the rotation goes into effect.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeZoneId

      CreateRotationRequest.Builder timeZoneId(String timeZoneId)

      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) and Pacific Daylight Time (PDT), are not supported.

      Parameters:
      timeZoneId - 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) and Pacific Daylight Time (PDT), are not supported.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recurrence

      CreateRotationRequest.Builder recurrence(RecurrenceSettings recurrence)

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

      Parameters:
      recurrence - Information about the rule that specifies when a shift's team members rotate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recurrence

      default CreateRotationRequest.Builder recurrence(Consumer<RecurrenceSettings.Builder> recurrence)

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

      This is a convenience method that creates an instance of the RecurrenceSettings.Builder avoiding the need to create one manually via RecurrenceSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to recurrence(RecurrenceSettings).

      Parameters:
      recurrence - a consumer that will call methods on RecurrenceSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateRotationRequest.Builder tags(Collection<Tag> tags)

      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.

      Parameters:
      tags - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateRotationRequest.Builder tags(Tag... tags)

      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.

      Parameters:
      tags - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateRotationRequest.Builder tags(Consumer<Tag.Builder>... tags)

      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.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • idempotencyToken

      CreateRotationRequest.Builder idempotencyToken(String idempotencyToken)

      A token that ensures that the operation is called only once with the specified details.

      Parameters:
      idempotencyToken - A token that ensures that the operation is called only once with the specified details.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateRotationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateRotationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.