Package software.amazon.awssdk.services.chime.model

Interface SipRule.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SipRule.Builder,SipRule>, SdkBuilder<SipRule.Builder,SipRule>, SdkPojo
Enclosing class:
SipRule
public static interface SipRule.Builder extends SdkPojo, CopyableBuilder<SipRule.Builder,SipRule>

  • Method Details

    • sipRuleId

      SipRule.Builder sipRuleId(String sipRuleId)

      The SIP rule ID.

      Parameters:
      sipRuleId - The SIP rule ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      SipRule.Builder name(String name)

      The name of the SIP rule.

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

    • disabled

      SipRule.Builder disabled(Boolean disabled)

      Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

      Parameters:
      disabled - Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggerType

      SipRule.Builder triggerType(String triggerType)

      The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

      Parameters:
      triggerType - The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • triggerType

      SipRule.Builder triggerType(SipRuleTriggerType triggerType)

      The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

      Parameters:
      triggerType - The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • triggerValue

      SipRule.Builder triggerValue(String triggerValue)

      If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

      Parameters:
      triggerValue - If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetApplications

      SipRule.Builder targetApplications(Collection<SipRuleTargetApplication> targetApplications)

      Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

      Parameters:
      targetApplications - Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetApplications

      SipRule.Builder targetApplications(SipRuleTargetApplication... targetApplications)

      Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

      Parameters:
      targetApplications - Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetApplications

      SipRule.Builder targetApplications(Consumer<SipRuleTargetApplication.Builder>... targetApplications)

      Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

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

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

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

    • createdTimestamp

      SipRule.Builder createdTimestamp(Instant createdTimestamp)

      The time at which the SIP rule was created, in ISO 8601 format.

      Parameters:
      createdTimestamp - The time at which the SIP rule was created, in ISO 8601 format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedTimestamp

      SipRule.Builder updatedTimestamp(Instant updatedTimestamp)

      The time at which the SIP rule was last updated, in ISO 8601 format.

      Parameters:
      updatedTimestamp - The time at which the SIP rule was last updated, in ISO 8601 format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.