NAME

Paws::Chime::CreateSipRule - Arguments for method CreateSipRule on Paws::Chime

DESCRIPTION

This class represents the parameters used for calling the method CreateSipRule on the Amazon Chime service. Use the attributes of this class as arguments to method CreateSipRule.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateSipRule.

SYNOPSIS

    my $chime = Paws->service('Chime');
    my $CreateSipRuleResponse = $chime->CreateSipRule(
      Name               => 'MySipRuleName',
      TargetApplications => [
        {
          AwsRegion             => 'MyString',            # OPTIONAL
          Priority              => 1,                     # min: 1; OPTIONAL
          SipMediaApplicationId => 'MyNonEmptyString',    # OPTIONAL
        },
        ...
      ],
      TriggerType  => 'ToPhoneNumber',
      TriggerValue => 'MyNonEmptyString',
      Disabled     => 1,                    # OPTIONAL
    );

    # Results:
    my $SipRule = $CreateSipRuleResponse->SipRule;

    # Returns a L<Paws::Chime::CreateSipRuleResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/chime/CreateSipRule

ATTRIBUTES

Disabled => Bool

Enables or disables a rule. You must disable rules before you can delete them.

REQUIRED Name => Str

The name of the SIP rule.

REQUIRED TargetApplications => ArrayRef[Paws::Chime::SipRuleTargetApplication]

List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.

REQUIRED TriggerType => Str

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

Valid values are: "ToPhoneNumber", "RequestUriHostname"

REQUIRED TriggerValue => Str

If TriggerType is RequestUriHostname, the value can be the outbound host name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateSipRule in Paws::Chime

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues