Interface CreateNotifyConfigurationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateNotifyConfigurationRequest.Builder,CreateNotifyConfigurationRequest>, PinpointSmsVoiceV2Request.Builder, SdkBuilder<CreateNotifyConfigurationRequest.Builder,CreateNotifyConfigurationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateNotifyConfigurationRequest
@Mutable @NotThreadSafe public static interface CreateNotifyConfigurationRequest.Builder extends PinpointSmsVoiceV2Request.Builder, SdkPojo, CopyableBuilder<CreateNotifyConfigurationRequest.Builder,CreateNotifyConfigurationRequest>

  • Method Details

    • displayName

      CreateNotifyConfigurationRequest.Builder displayName(String displayName)

      The display name to associate with the notify configuration.

      Parameters:
      displayName - The display name to associate with the notify configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • useCase

      CreateNotifyConfigurationRequest.Builder useCase(String useCase)

      The use case for the notify configuration.

      Parameters:
      useCase - The use case for the notify configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • useCase

      CreateNotifyConfigurationRequest.Builder useCase(NotifyConfigurationUseCase useCase)

      The use case for the notify configuration.

      Parameters:
      useCase - The use case for the notify configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • defaultTemplateId

      CreateNotifyConfigurationRequest.Builder defaultTemplateId(String defaultTemplateId)

      The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.

      Parameters:
      defaultTemplateId - The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • poolId

      CreateNotifyConfigurationRequest.Builder poolId(String poolId)

      The identifier of the pool to associate with the notify configuration.

      Parameters:
      poolId - The identifier of the pool to associate with the notify configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enabledCountries

      CreateNotifyConfigurationRequest.Builder enabledCountries(Collection<String> enabledCountries)

      An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.

      Parameters:
      enabledCountries - An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enabledCountries

      CreateNotifyConfigurationRequest.Builder enabledCountries(String... enabledCountries)

      An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.

      Parameters:
      enabledCountries - An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enabledChannelsWithStrings

      CreateNotifyConfigurationRequest.Builder enabledChannelsWithStrings(Collection<String> enabledChannels)

      An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.

      Parameters:
      enabledChannels - An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enabledChannelsWithStrings

      CreateNotifyConfigurationRequest.Builder enabledChannelsWithStrings(String... enabledChannels)

      An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.

      Parameters:
      enabledChannels - An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enabledChannels

      CreateNotifyConfigurationRequest.Builder enabledChannels(Collection<NumberCapability> enabledChannels)

      An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.

      Parameters:
      enabledChannels - An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enabledChannels

      CreateNotifyConfigurationRequest.Builder enabledChannels(NumberCapability... enabledChannels)

      An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.

      Parameters:
      enabledChannels - An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deletionProtectionEnabled

      CreateNotifyConfigurationRequest.Builder deletionProtectionEnabled(Boolean deletionProtectionEnabled)

      By default this is set to false. When set to true the notify configuration can't be deleted. You can change this value using the UpdateNotifyConfiguration action.

      Parameters:
      deletionProtectionEnabled - By default this is set to false. When set to true the notify configuration can't be deleted. You can change this value using the UpdateNotifyConfiguration action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateNotifyConfigurationRequest.Builder clientToken(String clientToken)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

      Parameters:
      clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateNotifyConfigurationRequest.Builder tags(Collection<Tag> tags)

      An array of tags (key and value pairs) associated with the notify configuration.

      Parameters:
      tags - An array of tags (key and value pairs) associated with the notify configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateNotifyConfigurationRequest.Builder tags(Tag... tags)

      An array of tags (key and value pairs) associated with the notify configuration.

      Parameters:
      tags - An array of tags (key and value pairs) associated with the notify configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateNotifyConfigurationRequest.Builder tags(Consumer<Tag.Builder>... tags)

      An array of tags (key and value pairs) associated with the notify configuration.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

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

    • overrideConfiguration

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

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