Class: Aws::SSMContacts::Types::CreateContactChannelRequest

Inherits:

Struct

• Object
• Struct
• Aws::SSMContacts::Types::CreateContactChannelRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssmcontacts/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #contact_id ⇒ String

  The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

• #defer_activation ⇒ Boolean

  If you want to activate the channel at a later time, you can choose to defer activation.

• #delivery_address ⇒ Types::ContactChannelAddress

  The details that Incident Manager uses when trying to engage the contact channel.

• #idempotency_token ⇒ String

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

• #name ⇒ String

  The name of the contact channel.

• #type ⇒ String

  Incident Manager supports three types of contact channels:.

Instance Attribute Details

#contact_id ⇒ String

The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

Returns:

• (String)

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

class CreateContactChannelRequest < Struct.new(
  :contact_id,
  :name,
  :type,
  :delivery_address,
  :defer_activation,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#defer_activation ⇒ Boolean

If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can’t engage your contact channel until it has been activated.

Returns:

• (Boolean)

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

class CreateContactChannelRequest < Struct.new(
  :contact_id,
  :name,
  :type,
  :delivery_address,
  :defer_activation,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_address ⇒ Types::ContactChannelAddress

The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:

• SMS - ‘+’ followed by the country code and phone number

• VOICE - ‘+’ followed by the country code and phone number

• EMAIL - any standard email format

Returns:

• (Types::ContactChannelAddress)

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

class CreateContactChannelRequest < Struct.new(
  :contact_id,
  :name,
  :type,
  :delivery_address,
  :defer_activation,
  :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 'lib/aws-sdk-ssmcontacts/types.rb', line 338

class CreateContactChannelRequest < Struct.new(
  :contact_id,
  :name,
  :type,
  :delivery_address,
  :defer_activation,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the contact channel.

Returns:

• (String)

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

class CreateContactChannelRequest < Struct.new(
  :contact_id,
  :name,
  :type,
  :delivery_address,
  :defer_activation,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

Incident Manager supports three types of contact channels:

• ‘SMS`

• ‘VOICE`

• ‘EMAIL`

Returns:

• (String)

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

class CreateContactChannelRequest < Struct.new(
  :contact_id,
  :name,
  :type,
  :delivery_address,
  :defer_activation,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end