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

Interface CreateContactChannelRequest.Builder

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

  • Method Details

    • contactId

      CreateContactChannelRequest.Builder contactId(String contactId)

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

      Parameters:
      contactId - The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateContactChannelRequest.Builder name(String name)

      The name of the contact channel.

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

    • type

      CreateContactChannelRequest.Builder type(String type)

      Incident Manager supports three types of contact channels:

      • SMS

      • VOICE

      • EMAIL

      Parameters:
      type - Incident Manager supports three types of contact channels:

      • SMS

      • VOICE

      • EMAIL

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

    • type

      CreateContactChannelRequest.Builder type(ChannelType type)

      Incident Manager supports three types of contact channels:

      • SMS

      • VOICE

      • EMAIL

      Parameters:
      type - Incident Manager supports three types of contact channels:

      • SMS

      • VOICE

      • EMAIL

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

    • deliveryAddress

      CreateContactChannelRequest.Builder deliveryAddress(ContactChannelAddress deliveryAddress)

      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

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

    • deliveryAddress

      default CreateContactChannelRequest.Builder deliveryAddress(Consumer<ContactChannelAddress.Builder> deliveryAddress)

      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

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

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

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

    • deferActivation

      CreateContactChannelRequest.Builder deferActivation(Boolean deferActivation)

      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.

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

    • idempotencyToken

      CreateContactChannelRequest.Builder idempotencyToken(String idempotencyToken)

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

      Parameters:
      idempotencyToken - A token ensuring 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

      CreateContactChannelRequest.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

      CreateContactChannelRequest.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.