Class: Aws::SSMContacts::Types::CreateRotationRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssmcontacts/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#contact_ids ⇒ Array<String>

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:

  • (Array<String>) 


527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/aws-sdk-ssmcontacts/types.rb', line 527

class CreateRotationRequest < Struct.new(
  :name,
  :contact_ids,
  :start_time,
  :time_zone_id,
  :recurrence,
  :tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#idempotency_token ⇒ String

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

Returns:

  • (String) 


527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/aws-sdk-ssmcontacts/types.rb', line 527

class CreateRotationRequest < Struct.new(
  :name,
  :contact_ids,
  :start_time,
  :time_zone_id,
  :recurrence,
  :tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the rotation.

Returns:

  • (String) 


527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/aws-sdk-ssmcontacts/types.rb', line 527

class CreateRotationRequest < Struct.new(
  :name,
  :contact_ids,
  :start_time,
  :time_zone_id,
  :recurrence,
  :tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#recurrence ⇒ Types::RecurrenceSettings

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

Returns:



527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/aws-sdk-ssmcontacts/types.rb', line 527

class CreateRotationRequest < Struct.new(
  :name,
  :contact_ids,
  :start_time,
  :time_zone_id,
  :recurrence,
  :tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The date and time that the rotation goes into effect.

Returns:

  • (Time) 


527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/aws-sdk-ssmcontacts/types.rb', line 527

class CreateRotationRequest < Struct.new(
  :name,
  :contact_ids,
  :start_time,
  :time_zone_id,
  :recurrence,
  :tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::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*.

[1]: docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html

Returns:



527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/aws-sdk-ssmcontacts/types.rb', line 527

class CreateRotationRequest < Struct.new(
  :name,
  :contact_ids,
  :start_time,
  :time_zone_id,
  :recurrence,
  :tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#time_zone_id ⇒ 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.

<note markdown=“1”> 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.

</note>

[1]: www.iana.org/time-zones

Returns:

  • (String) 


527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/aws-sdk-ssmcontacts/types.rb', line 527

class CreateRotationRequest < Struct.new(
  :name,
  :contact_ids,
  :start_time,
  :time_zone_id,
  :recurrence,
  :tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end