Class: Aws::SSMContacts::Types::CreateContactRequest

Inherits:

Struct

• Object
• Struct
• Aws::SSMContacts::Types::CreateContactRequest

Defined in:

gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #alias ⇒ String

  The short name to quickly identify a contact or escalation plan.

• #display_name ⇒ String

  The full name of the contact or escalation plan.

• #idempotency_token ⇒ String

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

• #plan ⇒ Types::Plan

  A list of stages.

• #tags ⇒ Array<Types::Tag>

  Adds a tag to the target.

• #type ⇒ String

  The type of contact to create.

Instance Attribute Details

#alias ⇒ String

The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.

Returns:

• (String)

# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 406

class CreateContactRequest < Struct.new(
  :alias,
  :display_name,
  :type,
  :plan,
  :tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The full name of the contact or escalation plan.

Returns:

• (String)

# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 406

class CreateContactRequest < Struct.new(
  :alias,
  :display_name,
  :type,
  :plan,
  :tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#idempotency_token ⇒ String

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

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 406

class CreateContactRequest < Struct.new(
  :alias,
  :display_name,
  :type,
  :plan,
  :tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#plan ⇒ Types::Plan

A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.

Returns:

• (Types::Plan)

# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 406

class CreateContactRequest < Struct.new(
  :alias,
  :display_name,
  :type,
  :plan,
  :tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Adds a tag to the target. You can only tag resources created in the first Region of your replication set.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 406

class CreateContactRequest < Struct.new(
  :alias,
  :display_name,
  :type,
  :plan,
  :tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of contact to create.

• PERSONAL: A single, individual contact.

• ESCALATION: An escalation plan.

• ONCALL_SCHEDULE: An on-call schedule.

Returns:

• (String)

# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 406

class CreateContactRequest < Struct.new(
  :alias,
  :display_name,
  :type,
  :plan,
  :tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end