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

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

Overview

Note:

When making an API call, you may pass CreateContactRequest data as a hash:

{
  alias: "ContactAlias", # required
  display_name: "ContactName",
  type: "PERSONAL", # required, accepts PERSONAL, ESCALATION
  plan: { # required
    stages: [ # required
      {
        duration_in_minutes: 1, # required
        targets: [ # required
          {
            channel_target_info: {
              contact_channel_id: "SsmContactsArn", # required
              retry_interval_in_minutes: 1,
            },
            contact_target_info: {
              contact_id: "SsmContactsArn",
              is_essential: false, # required
            },
          },
        ],
      },
    ],
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  idempotency_token: "IdempotencyToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aliasString

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

Returns:

  • (String)


463
464
465
466
467
468
469
470
471
472
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 463

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

#display_nameString

The full name of the contact or escalation plan.

Returns:

  • (String)


463
464
465
466
467
468
469
470
471
472
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 463

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

#idempotency_tokenString

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)


463
464
465
466
467
468
469
470
471
472
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 463

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

#planTypes::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:



463
464
465
466
467
468
469
470
471
472
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 463

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

#tagsArray<Types::Tag>

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

Returns:



463
464
465
466
467
468
469
470
471
472
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 463

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

#typeString

To create an escalation plan use ESCALATION. To create a contact use PERSONAL.

Returns:

  • (String)


463
464
465
466
467
468
469
470
471
472
# File 'gems/aws-sdk-ssmcontacts/lib/aws-sdk-ssmcontacts/types.rb', line 463

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